software.amazon.awssdk.services.pi

Interface PiAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface PiAsyncClient
extends SdkClient

Service client for accessing AWS PI asynchronously. This can be created using the static builder() method.

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	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static PiAsyncClientBuilder	builder() Create a builder that can be used to configure and create a PiAsyncClient.
static PiAsyncClient	create() Create a PiAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<DescribeDimensionKeysResponse>	describeDimensionKeys(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest) For a specific time period, retrieve the top N dimension keys for a metric.
default CompletableFuture<DescribeDimensionKeysResponse>	describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest) For a specific time period, retrieve the top N dimension keys for a metric.
default CompletableFuture<GetResourceMetricsResponse>	getResourceMetrics(Consumer<GetResourceMetricsRequest.Builder> getResourceMetricsRequest) Retrieve Performance Insights metrics for a set of data sources, over a time period.
default CompletableFuture<GetResourceMetricsResponse>	getResourceMetrics(GetResourceMetricsRequest getResourceMetricsRequest) Retrieve Performance Insights metrics for a set of data sources, over a time period.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static PiAsyncClient create()

Create a PiAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static PiAsyncClientBuilder builder()

Create a builder that can be used to configure and create a PiAsyncClient.

describeDimensionKeys

default CompletableFuture<DescribeDimensionKeysResponse> describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest)

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

Parameters:

describeDimensionKeysRequest -

Returns:

A Java Future containing the result of the DescribeDimensionKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeDimensionKeys

default CompletableFuture<DescribeDimensionKeysResponse> describeDimensionKeys(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest)

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

This is a convenience which creates an instance of the DescribeDimensionKeysRequest.Builder avoiding the need to create one manually via DescribeDimensionKeysRequest.builder()

Parameters:

describeDimensionKeysRequest - A Consumer that will call methods on DescribeDimensionKeysRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DescribeDimensionKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getResourceMetrics

default CompletableFuture<GetResourceMetricsResponse> 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:

A Java Future containing the result of the GetResourceMetrics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getResourceMetrics

default CompletableFuture<GetResourceMetricsResponse> getResourceMetrics(Consumer<GetResourceMetricsRequest.Builder> 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.

This is a convenience which creates an instance of the GetResourceMetricsRequest.Builder avoiding the need to create one manually via GetResourceMetricsRequest.builder()

Parameters:

getResourceMetricsRequest - A Consumer that will call methods on GetResourceMetricsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetResourceMetrics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation