@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSPIAsyncClient extends AWSPIClient implements AWSPIAsync
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
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 .
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createPerformanceAnalysisReport, deletePerformanceAnalysisReport, describeDimensionKeys, getCachedResponseMetadata, getDimensionKeyDetails, getPerformanceAnalysisReport, getResourceMetadata, getResourceMetrics, listAvailableResourceDimensions, listAvailableResourceMetrics, listPerformanceAnalysisReports, listTagsForResource, tagResource, untagResourceaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreatePerformanceAnalysisReport, deletePerformanceAnalysisReport, describeDimensionKeys, getCachedResponseMetadata, getDimensionKeyDetails, getPerformanceAnalysisReport, getResourceMetadata, getResourceMetrics, listAvailableResourceDimensions, listAvailableResourceMetrics, listPerformanceAnalysisReports, listTagsForResource, tagResource, untagResourcepublic static AWSPIAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreatePerformanceAnalysisReportResult> createPerformanceAnalysisReportAsync(CreatePerformanceAnalysisReportRequest request)
AWSPIAsyncCreates a new performance analysis report for a specific time period for the DB instance.
createPerformanceAnalysisReportAsync in interface AWSPIAsyncpublic Future<CreatePerformanceAnalysisReportResult> createPerformanceAnalysisReportAsync(CreatePerformanceAnalysisReportRequest request, AsyncHandler<CreatePerformanceAnalysisReportRequest,CreatePerformanceAnalysisReportResult> asyncHandler)
AWSPIAsyncCreates a new performance analysis report for a specific time period for the DB instance.
createPerformanceAnalysisReportAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeletePerformanceAnalysisReportResult> deletePerformanceAnalysisReportAsync(DeletePerformanceAnalysisReportRequest request)
AWSPIAsyncDeletes a performance analysis report.
deletePerformanceAnalysisReportAsync in interface AWSPIAsyncpublic Future<DeletePerformanceAnalysisReportResult> deletePerformanceAnalysisReportAsync(DeletePerformanceAnalysisReportRequest request, AsyncHandler<DeletePerformanceAnalysisReportRequest,DeletePerformanceAnalysisReportResult> asyncHandler)
AWSPIAsyncDeletes a performance analysis report.
deletePerformanceAnalysisReportAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDimensionKeysResult> describeDimensionKeysAsync(DescribeDimensionKeysRequest request)
AWSPIAsync
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.
describeDimensionKeysAsync in interface AWSPIAsyncpublic Future<DescribeDimensionKeysResult> describeDimensionKeysAsync(DescribeDimensionKeysRequest request, AsyncHandler<DescribeDimensionKeysRequest,DescribeDimensionKeysResult> asyncHandler)
AWSPIAsync
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.
describeDimensionKeysAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDimensionKeyDetailsResult> getDimensionKeyDetailsAsync(GetDimensionKeyDetailsRequest request)
AWSPIAsync
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.
getDimensionKeyDetailsAsync in interface AWSPIAsyncpublic Future<GetDimensionKeyDetailsResult> getDimensionKeyDetailsAsync(GetDimensionKeyDetailsRequest request, AsyncHandler<GetDimensionKeyDetailsRequest,GetDimensionKeyDetailsResult> asyncHandler)
AWSPIAsync
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.
getDimensionKeyDetailsAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetPerformanceAnalysisReportResult> getPerformanceAnalysisReportAsync(GetPerformanceAnalysisReportRequest request)
AWSPIAsync
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.
getPerformanceAnalysisReportAsync in interface AWSPIAsyncpublic Future<GetPerformanceAnalysisReportResult> getPerformanceAnalysisReportAsync(GetPerformanceAnalysisReportRequest request, AsyncHandler<GetPerformanceAnalysisReportRequest,GetPerformanceAnalysisReportResult> asyncHandler)
AWSPIAsync
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.
getPerformanceAnalysisReportAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetResourceMetadataResult> getResourceMetadataAsync(GetResourceMetadataRequest request)
AWSPIAsyncRetrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
getResourceMetadataAsync in interface AWSPIAsyncpublic Future<GetResourceMetadataResult> getResourceMetadataAsync(GetResourceMetadataRequest request, AsyncHandler<GetResourceMetadataRequest,GetResourceMetadataResult> asyncHandler)
AWSPIAsyncRetrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
getResourceMetadataAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetResourceMetricsResult> getResourceMetricsAsync(GetResourceMetricsRequest request)
AWSPIAsyncRetrieve 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.
getResourceMetricsAsync in interface AWSPIAsyncpublic Future<GetResourceMetricsResult> getResourceMetricsAsync(GetResourceMetricsRequest request, AsyncHandler<GetResourceMetricsRequest,GetResourceMetricsResult> asyncHandler)
AWSPIAsyncRetrieve 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.
getResourceMetricsAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAvailableResourceDimensionsResult> listAvailableResourceDimensionsAsync(ListAvailableResourceDimensionsRequest request)
AWSPIAsyncRetrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
listAvailableResourceDimensionsAsync in interface AWSPIAsyncpublic Future<ListAvailableResourceDimensionsResult> listAvailableResourceDimensionsAsync(ListAvailableResourceDimensionsRequest request, AsyncHandler<ListAvailableResourceDimensionsRequest,ListAvailableResourceDimensionsResult> asyncHandler)
AWSPIAsyncRetrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
listAvailableResourceDimensionsAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAvailableResourceMetricsResult> listAvailableResourceMetricsAsync(ListAvailableResourceMetricsRequest request)
AWSPIAsyncRetrieve metrics of the specified types that can be queried for a specified DB instance.
listAvailableResourceMetricsAsync in interface AWSPIAsyncpublic Future<ListAvailableResourceMetricsResult> listAvailableResourceMetricsAsync(ListAvailableResourceMetricsRequest request, AsyncHandler<ListAvailableResourceMetricsRequest,ListAvailableResourceMetricsResult> asyncHandler)
AWSPIAsyncRetrieve metrics of the specified types that can be queried for a specified DB instance.
listAvailableResourceMetricsAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPerformanceAnalysisReportsResult> listPerformanceAnalysisReportsAsync(ListPerformanceAnalysisReportsRequest request)
AWSPIAsyncLists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
listPerformanceAnalysisReportsAsync in interface AWSPIAsyncpublic Future<ListPerformanceAnalysisReportsResult> listPerformanceAnalysisReportsAsync(ListPerformanceAnalysisReportsRequest request, AsyncHandler<ListPerformanceAnalysisReportsRequest,ListPerformanceAnalysisReportsResult> asyncHandler)
AWSPIAsyncLists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
listPerformanceAnalysisReportsAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSPIAsyncRetrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
listTagsForResourceAsync in interface AWSPIAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSPIAsyncRetrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
listTagsForResourceAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSPIAsyncAdds metadata tags to the Amazon RDS Performance Insights resource.
tagResourceAsync in interface AWSPIAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSPIAsyncAdds metadata tags to the Amazon RDS Performance Insights resource.
tagResourceAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSPIAsyncDeletes the metadata tags from the Amazon RDS Performance Insights resource.
untagResourceAsync in interface AWSPIAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSPIAsyncDeletes the metadata tags from the Amazon RDS Performance Insights resource.
untagResourceAsync in interface AWSPIAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSPIshutdown in class AWSPIClient