AWSPIClient (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.pi

Class AWSPIClient

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.pi.AWSPIClient

All Implemented Interfaces:

AWSPI

Direct Known Subclasses:

AWSPIAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSPIClient
extends AmazonWebServiceClient
implements AWSPI 
```
Client for accessing AWS PI. All service calls made using this client are blocking, and will not return until the service call completes.
Amazon RDS Performance Insights
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
- To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide .
- To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide .
- To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide .

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.pi.AWSPI
  ENDPOINT_PREFIX

Method Summary

All Methods
Modifier and Type	Method and Description
`static AWSPIClientBuilder`	`builder ()`
`CreatePerformanceAnalysisReportResult`	`createPerformanceAnalysisReport (CreatePerformanceAnalysisReportRequest request)` Creates a new performance analysis report for a specific time period for the DB instance.
`DeletePerformanceAnalysisReportResult`	`deletePerformanceAnalysisReport (DeletePerformanceAnalysisReportRequest request)` Deletes a performance analysis report.
`DescribeDimensionKeysResult`	`describeDimensionKeys (DescribeDimensionKeysRequest request)` For a specific time period, retrieve the top `N` dimension keys for a metric.
`ResponseMetadata`	`getCachedResponseMetadata (AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetDimensionKeyDetailsResult`	`getDimensionKeyDetails (GetDimensionKeyDetailsRequest request)` Get the attributes of the specified dimension group for a DB instance or data source.
`GetPerformanceAnalysisReportResult`	`getPerformanceAnalysisReport (GetPerformanceAnalysisReportRequest request)` Retrieves the report including the report ID, status, time details, and the insights with recommendations.
`GetResourceMetadataResult`	`getResourceMetadata (GetResourceMetadataRequest request)` Retrieve the metadata for different features.
`GetResourceMetricsResult`	`getResourceMetrics (GetResourceMetricsRequest request)` Retrieve Performance Insights metrics for a set of data sources over a time period.
`ListAvailableResourceDimensionsResult`	`listAvailableResourceDimensions (ListAvailableResourceDimensionsRequest request)` Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
`ListAvailableResourceMetricsResult`	`listAvailableResourceMetrics (ListAvailableResourceMetricsRequest request)` Retrieve metrics of the specified types that can be queried for a specified DB instance.
`ListPerformanceAnalysisReportsResult`	`listPerformanceAnalysisReports (ListPerformanceAnalysisReportsRequest request)` Lists all the analysis reports created for the DB instance.
`ListTagsForResourceResult`	`listTagsForResource (ListTagsForResourceRequest request)` Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource (TagResourceRequest request)` Adds metadata tags to the Amazon RDS Performance Insights resource.
`UntagResourceResult`	`untagResource (UntagResourceRequest request)` Deletes the metadata tags from the Amazon RDS Performance Insights resource.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSPIClientBuilder builder()
```
  - createPerformanceAnalysisReport
```
public CreatePerformanceAnalysisReportResult createPerformanceAnalysisReport(CreatePerformanceAnalysisReportRequest request)
```
    Creates a new performance analysis report for a specific time period for the DB instance.
    
    Specified by:
    
    createPerformanceAnalysisReport in interface AWSPI
    
    Parameters:
    
    createPerformanceAnalysisReportRequest -
    
    Returns:
    
    Result of the CreatePerformanceAnalysisReport operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - deletePerformanceAnalysisReport
```
public DeletePerformanceAnalysisReportResult deletePerformanceAnalysisReport(DeletePerformanceAnalysisReportRequest request)
```
    Deletes a performance analysis report.
    
    Specified by:
    
    deletePerformanceAnalysisReport in interface AWSPI
    
    Parameters:
    
    deletePerformanceAnalysisReportRequest -
    
    Returns:
    
    Result of the DeletePerformanceAnalysisReport operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - describeDimensionKeys
```
public DescribeDimensionKeysResult describeDimensionKeys(DescribeDimensionKeysRequest request)
```
    For a specific time period, retrieve the top N dimension keys for a metric.
    
    Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
    
    Specified by:
    
    describeDimensionKeys in interface AWSPI
    
    Parameters:
    
    describeDimensionKeysRequest -
    
    Returns:
    
    Result of the DescribeDimensionKeys operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - getDimensionKeyDetails
```
public GetDimensionKeyDetailsResult getDimensionKeyDetails(GetDimensionKeyDetailsRequest request)
```
    Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.
    
    Specified by:
    
    getDimensionKeyDetails in interface AWSPI
    
    Parameters:
    
    getDimensionKeyDetailsRequest -
    
    Returns:
    
    Result of the GetDimensionKeyDetails operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - getPerformanceAnalysisReport
```
public GetPerformanceAnalysisReportResult getPerformanceAnalysisReport(GetPerformanceAnalysisReportRequest request)
```
    Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.
    
    Specified by:
    
    getPerformanceAnalysisReport in interface AWSPI
    
    Parameters:
    
    getPerformanceAnalysisReportRequest -
    
    Returns:
    
    Result of the GetPerformanceAnalysisReport operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - getResourceMetadata
```
public GetResourceMetadataResult getResourceMetadata(GetResourceMetadataRequest request)
```
    Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
    
    Specified by:
    
    getResourceMetadata in interface AWSPI
    
    Parameters:
    
    getResourceMetadataRequest -
    
    Returns:
    
    Result of the GetResourceMetadata operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - getResourceMetrics
```
public GetResourceMetricsResult getResourceMetrics(GetResourceMetricsRequest request)
```
    Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.
    
    Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
    
    Specified by:
    
    getResourceMetrics in interface AWSPI
    
    Parameters:
    
    getResourceMetricsRequest -
    
    Returns:
    
    Result of the GetResourceMetrics operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - listAvailableResourceDimensions
```
public ListAvailableResourceDimensionsResult listAvailableResourceDimensions(ListAvailableResourceDimensionsRequest request)
```
    Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
    
    Specified by:
    
    listAvailableResourceDimensions in interface AWSPI
    
    Parameters:
    
    listAvailableResourceDimensionsRequest -
    
    Returns:
    
    Result of the ListAvailableResourceDimensions operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - listAvailableResourceMetrics
```
public ListAvailableResourceMetricsResult listAvailableResourceMetrics(ListAvailableResourceMetricsRequest request)
```
    Retrieve metrics of the specified types that can be queried for a specified DB instance.
    
    Specified by:
    
    listAvailableResourceMetrics in interface AWSPI
    
    Parameters:
    
    listAvailableResourceMetricsRequest -
    
    Returns:
    
    Result of the ListAvailableResourceMetrics operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - listPerformanceAnalysisReports
```
public ListPerformanceAnalysisReportsResult listPerformanceAnalysisReports(ListPerformanceAnalysisReportsRequest request)
```
    Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
    
    Specified by:
    
    listPerformanceAnalysisReports in interface AWSPI
    
    Parameters:
    
    listPerformanceAnalysisReportsRequest -
    
    Returns:
    
    Result of the ListPerformanceAnalysisReports operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
    
    Specified by:
    
    listTagsForResource in interface AWSPI
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds metadata tags to the Amazon RDS Performance Insights resource.
    
    Specified by:
    
    tagResource in interface AWSPI
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Deletes the metadata tags from the Amazon RDS Performance Insights resource.
    
    Specified by:
    
    untagResource in interface AWSPI
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - One of the arguments provided is invalid for this request.
    
    InternalServiceErrorException - The request failed due to an unknown error.
    
    NotAuthorizedException - The user is not authorized to perform this request.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSPI
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSPI
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class AWSPIClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.pi.AWSPI

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

createPerformanceAnalysisReport

deletePerformanceAnalysisReport

describeDimensionKeys

getDimensionKeyDetails

getPerformanceAnalysisReport

getResourceMetadata

getResourceMetrics

listAvailableResourceDimensions

listAvailableResourceMetrics

listPerformanceAnalysisReports

listTagsForResource

tagResource

untagResource

getCachedResponseMetadata

shutdown