software.amazon.awssdk.services.pi

Interface PiClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS PI. This can be created using the static builder() method. 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

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
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 GetDimensionKeyDetailsResponse	getDimensionKeyDetails(Consumer<GetDimensionKeyDetailsRequest.Builder> getDimensionKeyDetailsRequest) Get the attributes of the specified dimension group for a DB instance or data source.
default GetDimensionKeyDetailsResponse	getDimensionKeyDetails(GetDimensionKeyDetailsRequest getDimensionKeyDetailsRequest) Get the attributes of the specified dimension group for a DB instance or data source.
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

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

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.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

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.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

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

getDimensionKeyDetails

default GetDimensionKeyDetailsResponse getDimensionKeyDetails(GetDimensionKeyDetailsRequest getDimensionKeyDetailsRequest)
                                                       throws InvalidArgumentException,
                                                              InternalServiceErrorException,
                                                              NotAuthorizedException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              PiException

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.

Parameters:

getDimensionKeyDetailsRequest -

Returns:

Result of the GetDimensionKeyDetails 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

getDimensionKeyDetails

default GetDimensionKeyDetailsResponse getDimensionKeyDetails(Consumer<GetDimensionKeyDetailsRequest.Builder> getDimensionKeyDetailsRequest)
                                                       throws InvalidArgumentException,
                                                              InternalServiceErrorException,
                                                              NotAuthorizedException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              PiException

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.

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

Parameters:

getDimensionKeyDetailsRequest - A Consumer that will call methods on GetDimensionKeyDetailsRequest.Builder to create a request.

Returns:

Result of the GetDimensionKeyDetails 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.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

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.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

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