AWSPI (AWS SDK for Java

All Known Subinterfaces:

AWSPIAsync

All Known Implementing Classes:

AbstractAWSPI, AbstractAWSPIAsync, AWSPIAsyncClient, AWSPIClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSPI
```
Interface for accessing AWS PI.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSPI instead.

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
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreatePerformanceAnalysisReportResult`	`createPerformanceAnalysisReport(CreatePerformanceAnalysisReportRequest createPerformanceAnalysisReportRequest)` Creates a new performance analysis report for a specific time period for the DB instance.
`DeletePerformanceAnalysisReportResult`	`deletePerformanceAnalysisReport(DeletePerformanceAnalysisReportRequest deletePerformanceAnalysisReportRequest)` Deletes a performance analysis report.
`DescribeDimensionKeysResult`	`describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest)` 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 getDimensionKeyDetailsRequest)` Get the attributes of the specified dimension group for a DB instance or data source.
`GetPerformanceAnalysisReportResult`	`getPerformanceAnalysisReport(GetPerformanceAnalysisReportRequest getPerformanceAnalysisReportRequest)` Retrieves the report including the report ID, status, time details, and the insights with recommendations.
`GetResourceMetadataResult`	`getResourceMetadata(GetResourceMetadataRequest getResourceMetadataRequest)` Retrieve the metadata for different features.
`GetResourceMetricsResult`	`getResourceMetrics(GetResourceMetricsRequest getResourceMetricsRequest)` Retrieve Performance Insights metrics for a set of data sources over a time period.
`ListAvailableResourceDimensionsResult`	`listAvailableResourceDimensions(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest)` Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
`ListAvailableResourceMetricsResult`	`listAvailableResourceMetrics(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest)` Retrieve metrics of the specified types that can be queried for a specified DB instance.
`ListPerformanceAnalysisReportsResult`	`listPerformanceAnalysisReports(ListPerformanceAnalysisReportsRequest listPerformanceAnalysisReportsRequest)` Lists all the analysis reports created for the DB instance.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` 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 tagResourceRequest)` Adds metadata tags to the Amazon RDS Performance Insights resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Deletes the metadata tags from the Amazon RDS Performance Insights resource.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createPerformanceAnalysisReport
```
CreatePerformanceAnalysisReportResult createPerformanceAnalysisReport(CreatePerformanceAnalysisReportRequest createPerformanceAnalysisReportRequest)
```
    Creates a new performance analysis report for a specific time period for the DB instance.
    
    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
```
DeletePerformanceAnalysisReportResult deletePerformanceAnalysisReport(DeletePerformanceAnalysisReportRequest deletePerformanceAnalysisReportRequest)
```
    Deletes a performance analysis report.
    
    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
```
DescribeDimensionKeysResult describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest)
```
    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.
    
    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
```
GetDimensionKeyDetailsResult getDimensionKeyDetails(GetDimensionKeyDetailsRequest getDimensionKeyDetailsRequest)
```
    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.
    
    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
```
GetPerformanceAnalysisReportResult getPerformanceAnalysisReport(GetPerformanceAnalysisReportRequest getPerformanceAnalysisReportRequest)
```
    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.
    
    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
```
GetResourceMetadataResult getResourceMetadata(GetResourceMetadataRequest getResourceMetadataRequest)
```
    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.
    
    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
```
GetResourceMetricsResult getResourceMetrics(GetResourceMetricsRequest getResourceMetricsRequest)
```
    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.
    
    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
```
ListAvailableResourceDimensionsResult listAvailableResourceDimensions(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest)
```
    Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
    
    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
```
ListAvailableResourceMetricsResult listAvailableResourceMetrics(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest)
```
    Retrieve metrics of the specified types that can be queried for a specified DB instance.
    
    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
```
ListPerformanceAnalysisReportsResult listPerformanceAnalysisReports(ListPerformanceAnalysisReportsRequest listPerformanceAnalysisReportsRequest)
```
    Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
    
    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
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
    
    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
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds metadata tags to the Amazon RDS Performance Insights resource.
    
    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
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Deletes the metadata tags from the Amazon RDS Performance Insights resource.
    
    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
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.773

Interface AWSPI

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createPerformanceAnalysisReport

deletePerformanceAnalysisReport

describeDimensionKeys

getDimensionKeyDetails

getPerformanceAnalysisReport

getResourceMetadata

getResourceMetrics

listAvailableResourceDimensions

listAvailableResourceMetrics

listPerformanceAnalysisReports

listTagsForResource

tagResource

untagResource

shutdown

getCachedResponseMetadata