com.amazonaws.services.pi

Interface AWSPI

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.

AWS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running RDS instance. The guide provides detailed information about Performance Insights data types, parameters and errors. For more information about Performance Insights capabilities see Using Amazon RDS Performance Insights in the Amazon RDS User Guide.

The AWS Performance Insights API provides visibility into the performance of your RDS instance, when Performance Insights is enabled for supported engine types. While Amazon CloudWatch provides the authoritative source for AWS service vended monitoring metrics, AWS Performance Insights offers a domain-specific view of database load measured as Average Active Sessions and provided to API consumers as a 2-dimensional time-series dataset. The time dimension of the data provides DB load data for each time point in the queried time range, and each time point decomposes overall load in relation to the requested dimensions, such as SQL, Wait-event, User or Host, measured at that time point.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
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.
GetResourceMetricsResult	getResourceMetrics(GetResourceMetricsRequest getResourceMetricsRequest) Retrieve Performance Insights metrics for a set of data sources, over a time period.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

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

describeDimensionKeys

DescribeDimensionKeysResult describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest)

For a specific time period, retrieve the top N dimension keys for a metric.

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

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 aggregation and filtering criteria for each group.

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

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.