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.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSPIClientBuilder	builder()
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.
GetResourceMetricsResult	getResourceMetrics(GetResourceMetricsRequest request) Retrieve Performance Insights metrics for a set of data sources, over a time period.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSPIClientBuilder builder()

describeDimensionKeys

public DescribeDimensionKeysResult describeDimensionKeys(DescribeDimensionKeysRequest request)

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

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

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

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

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.