com.amazonaws.services.pi

Class AWSPIAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.pi.AWSPIClient

com.amazonaws.services.pi.AWSPIAsyncClient

All Implemented Interfaces:

AWSPI, AWSPIAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSPIAsyncClient
extends AWSPIClient
implements AWSPIAsync

Client for accessing AWS PI asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation 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 AWS 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.

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

Modifier and Type	Method and Description
static AWSPIAsyncClientBuilder	asyncBuilder()
Future<DescribeDimensionKeysResult>	describeDimensionKeysAsync(DescribeDimensionKeysRequest request) For a specific time period, retrieve the top N dimension keys for a metric.
Future<DescribeDimensionKeysResult>	describeDimensionKeysAsync(DescribeDimensionKeysRequest request, AsyncHandler<DescribeDimensionKeysRequest,DescribeDimensionKeysResult> asyncHandler) For a specific time period, retrieve the top N dimension keys for a metric.
Future<GetDimensionKeyDetailsResult>	getDimensionKeyDetailsAsync(GetDimensionKeyDetailsRequest request) Get the attributes of the specified dimension group for a DB instance or data source.
Future<GetDimensionKeyDetailsResult>	getDimensionKeyDetailsAsync(GetDimensionKeyDetailsRequest request, AsyncHandler<GetDimensionKeyDetailsRequest,GetDimensionKeyDetailsResult> asyncHandler) Get the attributes of the specified dimension group for a DB instance or data source.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetResourceMetricsResult>	getResourceMetricsAsync(GetResourceMetricsRequest request) Retrieve Performance Insights metrics for a set of data sources, over a time period.
Future<GetResourceMetricsResult>	getResourceMetricsAsync(GetResourceMetricsRequest request, AsyncHandler<GetResourceMetricsRequest,GetResourceMetricsResult> asyncHandler) Retrieve Performance Insights metrics for a set of data sources, over a time period.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.pi.AWSPIClient

builder, describeDimensionKeys, getCachedResponseMetadata, getDimensionKeyDetails, getResourceMetrics

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

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

describeDimensionKeys, getCachedResponseMetadata, getDimensionKeyDetails, getResourceMetrics

Method Detail

asyncBuilder

public static AWSPIAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

describeDimensionKeysAsync

public Future<DescribeDimensionKeysResult> describeDimensionKeysAsync(DescribeDimensionKeysRequest request)

Description copied from interface: 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.

Specified by:

describeDimensionKeysAsync in interface AWSPIAsync

Returns:

A Java Future containing the result of the DescribeDimensionKeys operation returned by the service.

See Also:

AWS API Documentation

describeDimensionKeysAsync

public Future<DescribeDimensionKeysResult> describeDimensionKeysAsync(DescribeDimensionKeysRequest request,
                                                                      AsyncHandler<DescribeDimensionKeysRequest,DescribeDimensionKeysResult> asyncHandler)

Description copied from interface: 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.

Specified by:

describeDimensionKeysAsync in interface AWSPIAsync

asyncHandler - 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.

Returns:

A Java Future containing the result of the DescribeDimensionKeys operation returned by the service.

See Also:

AWS API Documentation

getDimensionKeyDetailsAsync

public Future<GetDimensionKeyDetailsResult> getDimensionKeyDetailsAsync(GetDimensionKeyDetailsRequest request)

Description copied from interface: 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.

Specified by:

getDimensionKeyDetailsAsync in interface AWSPIAsync

Returns:

A Java Future containing the result of the GetDimensionKeyDetails operation returned by the service.

See Also:

AWS API Documentation

getDimensionKeyDetailsAsync

public Future<GetDimensionKeyDetailsResult> getDimensionKeyDetailsAsync(GetDimensionKeyDetailsRequest request,
                                                                        AsyncHandler<GetDimensionKeyDetailsRequest,GetDimensionKeyDetailsResult> asyncHandler)

Description copied from interface: 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.

Specified by:

getDimensionKeyDetailsAsync in interface AWSPIAsync

asyncHandler - 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.

Returns:

A Java Future containing the result of the GetDimensionKeyDetails operation returned by the service.

See Also:

AWS API Documentation

getResourceMetricsAsync

public Future<GetResourceMetricsResult> getResourceMetricsAsync(GetResourceMetricsRequest request)

Description copied from interface: AWSPIAsync

Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

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:

getResourceMetricsAsync in interface AWSPIAsync

Returns:

A Java Future containing the result of the GetResourceMetrics operation returned by the service.

See Also:

AWS API Documentation

getResourceMetricsAsync

public Future<GetResourceMetricsResult> getResourceMetricsAsync(GetResourceMetricsRequest request,
                                                                AsyncHandler<GetResourceMetricsRequest,GetResourceMetricsResult> asyncHandler)

Description copied from interface: AWSPIAsync

Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

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:

getResourceMetricsAsync in interface AWSPIAsync

asyncHandler - 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.

Returns:

A Java Future containing the result of the GetResourceMetrics operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSPI

Overrides:

shutdown in class AWSPIClient