Interface PiClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 Amazon Web Services 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 .
-
To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide .
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic PiClientBuilder
builder()
Create a builder that can be used to configure and create aPiClient
.static PiClient
create()
Create aPiClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createPerformanceAnalysisReport
(Consumer<CreatePerformanceAnalysisReportRequest.Builder> createPerformanceAnalysisReportRequest) Creates a new performance analysis report for a specific time period for the DB instance.createPerformanceAnalysisReport
(CreatePerformanceAnalysisReportRequest createPerformanceAnalysisReportRequest) Creates a new performance analysis report for a specific time period for the DB instance.deletePerformanceAnalysisReport
(Consumer<DeletePerformanceAnalysisReportRequest.Builder> deletePerformanceAnalysisReportRequest) Deletes a performance analysis report.deletePerformanceAnalysisReport
(DeletePerformanceAnalysisReportRequest deletePerformanceAnalysisReportRequest) Deletes a performance analysis report.default DescribeDimensionKeysResponse
describeDimensionKeys
(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest) For a specific time period, retrieve the topN
dimension keys for a metric.default DescribeDimensionKeysResponse
describeDimensionKeys
(DescribeDimensionKeysRequest describeDimensionKeysRequest) For a specific time period, retrieve the topN
dimension keys for a metric.default DescribeDimensionKeysIterable
describeDimensionKeysPaginator
(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest) This is a variant ofdescribeDimensionKeys(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest)
operation.default DescribeDimensionKeysIterable
describeDimensionKeysPaginator
(DescribeDimensionKeysRequest describeDimensionKeysRequest) This is a variant ofdescribeDimensionKeys(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest)
operation.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.getPerformanceAnalysisReport
(Consumer<GetPerformanceAnalysisReportRequest.Builder> getPerformanceAnalysisReportRequest) Retrieves the report including the report ID, status, time details, and the insights with recommendations.getPerformanceAnalysisReport
(GetPerformanceAnalysisReportRequest getPerformanceAnalysisReportRequest) Retrieves the report including the report ID, status, time details, and the insights with recommendations.default GetResourceMetadataResponse
getResourceMetadata
(Consumer<GetResourceMetadataRequest.Builder> getResourceMetadataRequest) Retrieve the metadata for different features.default GetResourceMetadataResponse
getResourceMetadata
(GetResourceMetadataRequest getResourceMetadataRequest) Retrieve the metadata for different features.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.default GetResourceMetricsIterable
getResourceMetricsPaginator
(Consumer<GetResourceMetricsRequest.Builder> getResourceMetricsRequest) This is a variant ofgetResourceMetrics(software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest)
operation.default GetResourceMetricsIterable
getResourceMetricsPaginator
(GetResourceMetricsRequest getResourceMetricsRequest) This is a variant ofgetResourceMetrics(software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest)
operation.listAvailableResourceDimensions
(Consumer<ListAvailableResourceDimensionsRequest.Builder> listAvailableResourceDimensionsRequest) Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.listAvailableResourceDimensions
(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest) Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.listAvailableResourceDimensionsPaginator
(Consumer<ListAvailableResourceDimensionsRequest.Builder> listAvailableResourceDimensionsRequest) This is a variant oflistAvailableResourceDimensions(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsRequest)
operation.listAvailableResourceDimensionsPaginator
(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest) This is a variant oflistAvailableResourceDimensions(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsRequest)
operation.listAvailableResourceMetrics
(Consumer<ListAvailableResourceMetricsRequest.Builder> listAvailableResourceMetricsRequest) Retrieve metrics of the specified types that can be queried for a specified DB instance.listAvailableResourceMetrics
(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest) Retrieve metrics of the specified types that can be queried for a specified DB instance.listAvailableResourceMetricsPaginator
(Consumer<ListAvailableResourceMetricsRequest.Builder> listAvailableResourceMetricsRequest) This is a variant oflistAvailableResourceMetrics(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsRequest)
operation.listAvailableResourceMetricsPaginator
(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest) This is a variant oflistAvailableResourceMetrics(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsRequest)
operation.listPerformanceAnalysisReports
(Consumer<ListPerformanceAnalysisReportsRequest.Builder> listPerformanceAnalysisReportsRequest) Lists all the analysis reports created for the DB instance.listPerformanceAnalysisReports
(ListPerformanceAnalysisReportsRequest listPerformanceAnalysisReportsRequest) Lists all the analysis reports created for the DB instance.listPerformanceAnalysisReportsPaginator
(Consumer<ListPerformanceAnalysisReportsRequest.Builder> listPerformanceAnalysisReportsRequest) This is a variant oflistPerformanceAnalysisReports(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsRequest)
operation.listPerformanceAnalysisReportsPaginator
(ListPerformanceAnalysisReportsRequest listPerformanceAnalysisReportsRequest) This is a variant oflistPerformanceAnalysisReports(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.default PiServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds metadata tags to the Amazon RDS Performance Insights resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds metadata tags to the Amazon RDS Performance Insights resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes the metadata tags from the Amazon RDS Performance Insights resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Deletes the metadata tags from the Amazon RDS Performance Insights resource.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createPerformanceAnalysisReport
default CreatePerformanceAnalysisReportResponse createPerformanceAnalysisReport(CreatePerformanceAnalysisReportRequest createPerformanceAnalysisReportRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Creates a new performance analysis report for a specific time period for the DB instance.
- Parameters:
createPerformanceAnalysisReportRequest
-- Returns:
- Result of the CreatePerformanceAnalysisReport operation returned by the service.
- See Also:
-
createPerformanceAnalysisReport
default CreatePerformanceAnalysisReportResponse createPerformanceAnalysisReport(Consumer<CreatePerformanceAnalysisReportRequest.Builder> createPerformanceAnalysisReportRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Creates a new performance analysis report for a specific time period for the DB instance.
This is a convenience which creates an instance of the
CreatePerformanceAnalysisReportRequest.Builder
avoiding the need to create one manually viaCreatePerformanceAnalysisReportRequest.builder()
- Parameters:
createPerformanceAnalysisReportRequest
- AConsumer
that will call methods onCreatePerformanceAnalysisReportRequest.Builder
to create a request.- Returns:
- Result of the CreatePerformanceAnalysisReport operation returned by the service.
- See Also:
-
deletePerformanceAnalysisReport
default DeletePerformanceAnalysisReportResponse deletePerformanceAnalysisReport(DeletePerformanceAnalysisReportRequest deletePerformanceAnalysisReportRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Deletes a performance analysis report.
- Parameters:
deletePerformanceAnalysisReportRequest
-- Returns:
- Result of the DeletePerformanceAnalysisReport operation returned by the service.
- See Also:
-
deletePerformanceAnalysisReport
default DeletePerformanceAnalysisReportResponse deletePerformanceAnalysisReport(Consumer<DeletePerformanceAnalysisReportRequest.Builder> deletePerformanceAnalysisReportRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Deletes a performance analysis report.
This is a convenience which creates an instance of the
DeletePerformanceAnalysisReportRequest.Builder
avoiding the need to create one manually viaDeletePerformanceAnalysisReportRequest.builder()
- Parameters:
deletePerformanceAnalysisReportRequest
- AConsumer
that will call methods onDeletePerformanceAnalysisReportRequest.Builder
to create a request.- Returns:
- Result of the DeletePerformanceAnalysisReport operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeDimensionKeysRequest.builder()
- Parameters:
describeDimensionKeysRequest
- AConsumer
that will call methods onDescribeDimensionKeysRequest.Builder
to create a request.- Returns:
- Result of the DescribeDimensionKeys operation returned by the service.
- See Also:
-
describeDimensionKeysPaginator
default DescribeDimensionKeysIterable describeDimensionKeysPaginator(DescribeDimensionKeysRequest describeDimensionKeysRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException This is a variant of
describeDimensionKeys(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.pi.paginators.DescribeDimensionKeysIterable responses = client.describeDimensionKeysPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pi.paginators.DescribeDimensionKeysIterable responses = client .describeDimensionKeysPaginator(request); for (software.amazon.awssdk.services.pi.model.DescribeDimensionKeysResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pi.paginators.DescribeDimensionKeysIterable responses = client.describeDimensionKeysPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDimensionKeys(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest)
operation.- Parameters:
describeDimensionKeysRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDimensionKeysPaginator
default DescribeDimensionKeysIterable describeDimensionKeysPaginator(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException This is a variant of
describeDimensionKeys(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.pi.paginators.DescribeDimensionKeysIterable responses = client.describeDimensionKeysPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pi.paginators.DescribeDimensionKeysIterable responses = client .describeDimensionKeysPaginator(request); for (software.amazon.awssdk.services.pi.model.DescribeDimensionKeysResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pi.paginators.DescribeDimensionKeysIterable responses = client.describeDimensionKeysPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDimensionKeys(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest)
operation.
This is a convenience which creates an instance of the
DescribeDimensionKeysRequest.Builder
avoiding the need to create one manually viaDescribeDimensionKeysRequest.builder()
- Parameters:
describeDimensionKeysRequest
- AConsumer
that will call methods onDescribeDimensionKeysRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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 dimensiondb.sql.statement
associated with this ID. This operation is useful becauseGetResourceMetrics
andDescribeDimensionKeys
don't support retrieval of large SQL statement text.- Parameters:
getDimensionKeyDetailsRequest
-- Returns:
- Result of the GetDimensionKeyDetails operation returned by the service.
- See Also:
-
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 dimensiondb.sql.statement
associated with this ID. This operation is useful becauseGetResourceMetrics
andDescribeDimensionKeys
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 viaGetDimensionKeyDetailsRequest.builder()
- Parameters:
getDimensionKeyDetailsRequest
- AConsumer
that will call methods onGetDimensionKeyDetailsRequest.Builder
to create a request.- Returns:
- Result of the GetDimensionKeyDetails operation returned by the service.
- See Also:
-
getPerformanceAnalysisReport
default GetPerformanceAnalysisReportResponse getPerformanceAnalysisReport(GetPerformanceAnalysisReportRequest getPerformanceAnalysisReportRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be
RUNNING
,SUCCEEDED
, orFAILED
. The insights include thedescription
andrecommendation
fields.- Parameters:
getPerformanceAnalysisReportRequest
-- Returns:
- Result of the GetPerformanceAnalysisReport operation returned by the service.
- See Also:
-
getPerformanceAnalysisReport
default GetPerformanceAnalysisReportResponse getPerformanceAnalysisReport(Consumer<GetPerformanceAnalysisReportRequest.Builder> getPerformanceAnalysisReportRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be
RUNNING
,SUCCEEDED
, orFAILED
. The insights include thedescription
andrecommendation
fields.
This is a convenience which creates an instance of the
GetPerformanceAnalysisReportRequest.Builder
avoiding the need to create one manually viaGetPerformanceAnalysisReportRequest.builder()
- Parameters:
getPerformanceAnalysisReportRequest
- AConsumer
that will call methods onGetPerformanceAnalysisReportRequest.Builder
to create a request.- Returns:
- Result of the GetPerformanceAnalysisReport operation returned by the service.
- See Also:
-
getResourceMetadata
default GetResourceMetadataResponse getResourceMetadata(GetResourceMetadataRequest getResourceMetadataRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
- Parameters:
getResourceMetadataRequest
-- Returns:
- Result of the GetResourceMetadata operation returned by the service.
- See Also:
-
getResourceMetadata
default GetResourceMetadataResponse getResourceMetadata(Consumer<GetResourceMetadataRequest.Builder> getResourceMetadataRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
This is a convenience which creates an instance of the
GetResourceMetadataRequest.Builder
avoiding the need to create one manually viaGetResourceMetadataRequest.builder()
- Parameters:
getResourceMetadataRequest
- AConsumer
that will call methods onGetResourceMetadataRequest.Builder
to create a request.- Returns:
- Result of the GetResourceMetadata operation returned by the service.
- See Also:
-
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 filtering criteria for each group. You must specify an aggregate function for each 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:
getResourceMetricsRequest
-- Returns:
- Result of the GetResourceMetrics operation returned by the service.
- See Also:
-
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 filtering criteria for each group. You must specify an aggregate function for each 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
GetResourceMetricsRequest.Builder
avoiding the need to create one manually viaGetResourceMetricsRequest.builder()
- Parameters:
getResourceMetricsRequest
- AConsumer
that will call methods onGetResourceMetricsRequest.Builder
to create a request.- Returns:
- Result of the GetResourceMetrics operation returned by the service.
- See Also:
-
getResourceMetricsPaginator
default GetResourceMetricsIterable getResourceMetricsPaginator(GetResourceMetricsRequest getResourceMetricsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException This is a variant of
getResourceMetrics(software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.pi.paginators.GetResourceMetricsIterable responses = client.getResourceMetricsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pi.paginators.GetResourceMetricsIterable responses = client .getResourceMetricsPaginator(request); for (software.amazon.awssdk.services.pi.model.GetResourceMetricsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pi.paginators.GetResourceMetricsIterable responses = client.getResourceMetricsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResourceMetrics(software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest)
operation.- Parameters:
getResourceMetricsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getResourceMetricsPaginator
default GetResourceMetricsIterable getResourceMetricsPaginator(Consumer<GetResourceMetricsRequest.Builder> getResourceMetricsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException This is a variant of
getResourceMetrics(software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.pi.paginators.GetResourceMetricsIterable responses = client.getResourceMetricsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pi.paginators.GetResourceMetricsIterable responses = client .getResourceMetricsPaginator(request); for (software.amazon.awssdk.services.pi.model.GetResourceMetricsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pi.paginators.GetResourceMetricsIterable responses = client.getResourceMetricsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResourceMetrics(software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest)
operation.
This is a convenience which creates an instance of the
GetResourceMetricsRequest.Builder
avoiding the need to create one manually viaGetResourceMetricsRequest.builder()
- Parameters:
getResourceMetricsRequest
- AConsumer
that will call methods onGetResourceMetricsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAvailableResourceDimensions
default ListAvailableResourceDimensionsResponse listAvailableResourceDimensions(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
- Parameters:
listAvailableResourceDimensionsRequest
-- Returns:
- Result of the ListAvailableResourceDimensions operation returned by the service.
- See Also:
-
listAvailableResourceDimensions
default ListAvailableResourceDimensionsResponse listAvailableResourceDimensions(Consumer<ListAvailableResourceDimensionsRequest.Builder> listAvailableResourceDimensionsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
This is a convenience which creates an instance of the
ListAvailableResourceDimensionsRequest.Builder
avoiding the need to create one manually viaListAvailableResourceDimensionsRequest.builder()
- Parameters:
listAvailableResourceDimensionsRequest
- AConsumer
that will call methods onListAvailableResourceDimensionsRequest.Builder
to create a request.- Returns:
- Result of the ListAvailableResourceDimensions operation returned by the service.
- See Also:
-
listAvailableResourceDimensionsPaginator
default ListAvailableResourceDimensionsIterable listAvailableResourceDimensionsPaginator(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException This is a variant of
listAvailableResourceDimensions(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.pi.paginators.ListAvailableResourceDimensionsIterable responses = client.listAvailableResourceDimensionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pi.paginators.ListAvailableResourceDimensionsIterable responses = client .listAvailableResourceDimensionsPaginator(request); for (software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pi.paginators.ListAvailableResourceDimensionsIterable responses = client.listAvailableResourceDimensionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAvailableResourceDimensions(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsRequest)
operation.- Parameters:
listAvailableResourceDimensionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAvailableResourceDimensionsPaginator
default ListAvailableResourceDimensionsIterable listAvailableResourceDimensionsPaginator(Consumer<ListAvailableResourceDimensionsRequest.Builder> listAvailableResourceDimensionsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException This is a variant of
listAvailableResourceDimensions(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.pi.paginators.ListAvailableResourceDimensionsIterable responses = client.listAvailableResourceDimensionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pi.paginators.ListAvailableResourceDimensionsIterable responses = client .listAvailableResourceDimensionsPaginator(request); for (software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pi.paginators.ListAvailableResourceDimensionsIterable responses = client.listAvailableResourceDimensionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAvailableResourceDimensions(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsRequest)
operation.
This is a convenience which creates an instance of the
ListAvailableResourceDimensionsRequest.Builder
avoiding the need to create one manually viaListAvailableResourceDimensionsRequest.builder()
- Parameters:
listAvailableResourceDimensionsRequest
- AConsumer
that will call methods onListAvailableResourceDimensionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAvailableResourceMetrics
default ListAvailableResourceMetricsResponse listAvailableResourceMetrics(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Retrieve metrics of the specified types that can be queried for a specified DB instance.
- Parameters:
listAvailableResourceMetricsRequest
-- Returns:
- Result of the ListAvailableResourceMetrics operation returned by the service.
- See Also:
-
listAvailableResourceMetrics
default ListAvailableResourceMetricsResponse listAvailableResourceMetrics(Consumer<ListAvailableResourceMetricsRequest.Builder> listAvailableResourceMetricsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Retrieve metrics of the specified types that can be queried for a specified DB instance.
This is a convenience which creates an instance of the
ListAvailableResourceMetricsRequest.Builder
avoiding the need to create one manually viaListAvailableResourceMetricsRequest.builder()
- Parameters:
listAvailableResourceMetricsRequest
- AConsumer
that will call methods onListAvailableResourceMetricsRequest.Builder
to create a request.- Returns:
- Result of the ListAvailableResourceMetrics operation returned by the service.
- See Also:
-
listAvailableResourceMetricsPaginator
default ListAvailableResourceMetricsIterable listAvailableResourceMetricsPaginator(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException This is a variant of
listAvailableResourceMetrics(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.pi.paginators.ListAvailableResourceMetricsIterable responses = client.listAvailableResourceMetricsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pi.paginators.ListAvailableResourceMetricsIterable responses = client .listAvailableResourceMetricsPaginator(request); for (software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pi.paginators.ListAvailableResourceMetricsIterable responses = client.listAvailableResourceMetricsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAvailableResourceMetrics(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsRequest)
operation.- Parameters:
listAvailableResourceMetricsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAvailableResourceMetricsPaginator
default ListAvailableResourceMetricsIterable listAvailableResourceMetricsPaginator(Consumer<ListAvailableResourceMetricsRequest.Builder> listAvailableResourceMetricsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException This is a variant of
listAvailableResourceMetrics(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.pi.paginators.ListAvailableResourceMetricsIterable responses = client.listAvailableResourceMetricsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pi.paginators.ListAvailableResourceMetricsIterable responses = client .listAvailableResourceMetricsPaginator(request); for (software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pi.paginators.ListAvailableResourceMetricsIterable responses = client.listAvailableResourceMetricsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAvailableResourceMetrics(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsRequest)
operation.
This is a convenience which creates an instance of the
ListAvailableResourceMetricsRequest.Builder
avoiding the need to create one manually viaListAvailableResourceMetricsRequest.builder()
- Parameters:
listAvailableResourceMetricsRequest
- AConsumer
that will call methods onListAvailableResourceMetricsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPerformanceAnalysisReports
default ListPerformanceAnalysisReportsResponse listPerformanceAnalysisReports(ListPerformanceAnalysisReportsRequest listPerformanceAnalysisReportsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
- Parameters:
listPerformanceAnalysisReportsRequest
-- Returns:
- Result of the ListPerformanceAnalysisReports operation returned by the service.
- See Also:
-
listPerformanceAnalysisReports
default ListPerformanceAnalysisReportsResponse listPerformanceAnalysisReports(Consumer<ListPerformanceAnalysisReportsRequest.Builder> listPerformanceAnalysisReportsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
This is a convenience which creates an instance of the
ListPerformanceAnalysisReportsRequest.Builder
avoiding the need to create one manually viaListPerformanceAnalysisReportsRequest.builder()
- Parameters:
listPerformanceAnalysisReportsRequest
- AConsumer
that will call methods onListPerformanceAnalysisReportsRequest.Builder
to create a request.- Returns:
- Result of the ListPerformanceAnalysisReports operation returned by the service.
- See Also:
-
listPerformanceAnalysisReportsPaginator
default ListPerformanceAnalysisReportsIterable listPerformanceAnalysisReportsPaginator(ListPerformanceAnalysisReportsRequest listPerformanceAnalysisReportsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException This is a variant of
listPerformanceAnalysisReports(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.pi.paginators.ListPerformanceAnalysisReportsIterable responses = client.listPerformanceAnalysisReportsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pi.paginators.ListPerformanceAnalysisReportsIterable responses = client .listPerformanceAnalysisReportsPaginator(request); for (software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pi.paginators.ListPerformanceAnalysisReportsIterable responses = client.listPerformanceAnalysisReportsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPerformanceAnalysisReports(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsRequest)
operation.- Parameters:
listPerformanceAnalysisReportsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPerformanceAnalysisReportsPaginator
default ListPerformanceAnalysisReportsIterable listPerformanceAnalysisReportsPaginator(Consumer<ListPerformanceAnalysisReportsRequest.Builder> listPerformanceAnalysisReportsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException This is a variant of
listPerformanceAnalysisReports(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.pi.paginators.ListPerformanceAnalysisReportsIterable responses = client.listPerformanceAnalysisReportsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pi.paginators.ListPerformanceAnalysisReportsIterable responses = client .listPerformanceAnalysisReportsPaginator(request); for (software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pi.paginators.ListPerformanceAnalysisReportsIterable responses = client.listPerformanceAnalysisReportsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPerformanceAnalysisReports(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsRequest)
operation.
This is a convenience which creates an instance of the
ListPerformanceAnalysisReportsRequest.Builder
avoiding the need to create one manually viaListPerformanceAnalysisReportsRequest.builder()
- Parameters:
listPerformanceAnalysisReportsRequest
- AConsumer
that will call methods onListPerformanceAnalysisReportsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Adds metadata tags to the Amazon RDS Performance Insights resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Adds metadata tags to the Amazon RDS Performance Insights resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Deletes the metadata tags from the Amazon RDS Performance Insights resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException Deletes the metadata tags from the Amazon RDS Performance Insights resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
create
Create aPiClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPiClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-