software.amazon.awssdk.services.pi

Interface PiClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS PI. 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 PiClientBuilder	builder() Create a builder that can be used to configure and create a PiClient.
static PiClient	create() Create a PiClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DescribeDimensionKeysResponse	describeDimensionKeys(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest) For a specific time period, retrieve the top N dimension keys for a metric.
default DescribeDimensionKeysResponse	describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest) For a specific time period, retrieve the top N dimension keys for a metric.
default GetResourceMetricsResponse	getResourceMetrics(Consumer<GetResourceMetricsRequest.Builder> getResourceMetricsRequest) Retrieve Performance Insights metrics for a set of data sources, over a time period.
default GetResourceMetricsResponse	getResourceMetrics(GetResourceMetricsRequest getResourceMetricsRequest) Retrieve Performance Insights metrics for a set of data sources, over a time period.
static ServiceMetadata	serviceMetadata()

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 PiClient create()

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

builder

static PiClientBuilder builder()

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

describeDimensionKeys

default DescribeDimensionKeysResponse describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest)
                                                     throws InvalidArgumentException,
                                                            InternalServiceErrorException,
                                                            NotAuthorizedException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            PiException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

describeDimensionKeys

default DescribeDimensionKeysResponse describeDimensionKeys(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest)
                                                     throws InvalidArgumentException,
                                                            InternalServiceErrorException,
                                                            NotAuthorizedException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            PiException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getResourceMetrics

default GetResourceMetricsResponse getResourceMetrics(GetResourceMetricsRequest getResourceMetricsRequest)
                                               throws InvalidArgumentException,
                                                      InternalServiceErrorException,
                                                      NotAuthorizedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      PiException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getResourceMetrics

default GetResourceMetricsResponse getResourceMetrics(Consumer<GetResourceMetricsRequest.Builder> getResourceMetricsRequest)
                                               throws InvalidArgumentException,
                                                      InternalServiceErrorException,
                                                      NotAuthorizedException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      PiException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()