@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface PiClient extends 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 .
| 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 |
| 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 DescribeDimensionKeysIterable |
describeDimensionKeysPaginator(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest)
For a specific time period, retrieve the top
N dimension keys for a metric. |
default DescribeDimensionKeysIterable |
describeDimensionKeysPaginator(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 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)
Retrieve Performance Insights metrics for a set of data sources over a time period.
|
default GetResourceMetricsIterable |
getResourceMetricsPaginator(GetResourceMetricsRequest getResourceMetricsRequest)
Retrieve Performance Insights metrics for a set of data sources over a time period.
|
default ListAvailableResourceDimensionsResponse |
listAvailableResourceDimensions(Consumer<ListAvailableResourceDimensionsRequest.Builder> listAvailableResourceDimensionsRequest)
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
|
default ListAvailableResourceDimensionsResponse |
listAvailableResourceDimensions(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest)
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
|
default ListAvailableResourceDimensionsIterable |
listAvailableResourceDimensionsPaginator(Consumer<ListAvailableResourceDimensionsRequest.Builder> listAvailableResourceDimensionsRequest)
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
|
default ListAvailableResourceDimensionsIterable |
listAvailableResourceDimensionsPaginator(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest)
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
|
default ListAvailableResourceMetricsResponse |
listAvailableResourceMetrics(Consumer<ListAvailableResourceMetricsRequest.Builder> listAvailableResourceMetricsRequest)
Retrieve metrics of the specified types that can be queried for a specified DB instance.
|
default ListAvailableResourceMetricsResponse |
listAvailableResourceMetrics(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest)
Retrieve metrics of the specified types that can be queried for a specified DB instance.
|
default ListAvailableResourceMetricsIterable |
listAvailableResourceMetricsPaginator(Consumer<ListAvailableResourceMetricsRequest.Builder> listAvailableResourceMetricsRequest)
Retrieve metrics of the specified types that can be queried for a specified DB instance.
|
default ListAvailableResourceMetricsIterable |
listAvailableResourceMetricsPaginator(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest)
Retrieve metrics of the specified types that can be queried for a specified DB instance.
|
static ServiceMetadata |
serviceMetadata() |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
describeDimensionKeysRequest - 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.AwsServiceExceptiondefault 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()
describeDimensionKeysRequest - A Consumer that will call methods on DescribeDimensionKeysRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeDimensionKeysIterable describeDimensionKeysPaginator(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.
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 Stream
software.amazon.awssdk.services.pi.paginators.DescribeDimensionKeysIterable responses = client.describeDimensionKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeDimensionKeysRequest - 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.AwsServiceExceptiondefault DescribeDimensionKeysIterable describeDimensionKeysPaginator(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 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 Stream
software.amazon.awssdk.services.pi.paginators.DescribeDimensionKeysIterable responses = client.describeDimensionKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via DescribeDimensionKeysRequest.builder()
describeDimensionKeysRequest - A Consumer that will call methods on DescribeDimensionKeysRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
getDimensionKeyDetailsRequest - 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.AwsServiceExceptiondefault 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()
getDimensionKeyDetailsRequest - A Consumer that will call methods on GetDimensionKeyDetailsRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
getResourceMetadataRequest - 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.AwsServiceExceptiondefault 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 via GetResourceMetadataRequest.builder()
getResourceMetadataRequest - A Consumer that will call methods on GetResourceMetadataRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
getResourceMetricsRequest - 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.AwsServiceExceptiondefault 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()
getResourceMetricsRequest - A Consumer that will call methods on GetResourceMetricsRequest.Builder to create a
request.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.AwsServiceExceptiondefault GetResourceMetricsIterable getResourceMetricsPaginator(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.
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 Stream
software.amazon.awssdk.services.pi.paginators.GetResourceMetricsIterable responses = client.getResourceMetricsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
getResourceMetricsRequest - 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.AwsServiceExceptiondefault GetResourceMetricsIterable getResourceMetricsPaginator(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 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 Stream
software.amazon.awssdk.services.pi.paginators.GetResourceMetricsIterable responses = client.getResourceMetricsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via GetResourceMetricsRequest.builder()
getResourceMetricsRequest - A Consumer that will call methods on GetResourceMetricsRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
listAvailableResourceDimensionsRequest - 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.AwsServiceExceptiondefault 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 via ListAvailableResourceDimensionsRequest.builder()
listAvailableResourceDimensionsRequest - A Consumer that will call methods on ListAvailableResourceDimensionsRequest.Builder to
create a request.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.AwsServiceExceptiondefault ListAvailableResourceDimensionsIterable listAvailableResourceDimensionsPaginator(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.
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 Stream
software.amazon.awssdk.services.pi.paginators.ListAvailableResourceDimensionsIterable responses = client.listAvailableResourceDimensionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listAvailableResourceDimensionsRequest - 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.AwsServiceExceptiondefault ListAvailableResourceDimensionsIterable listAvailableResourceDimensionsPaginator(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 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 Stream
software.amazon.awssdk.services.pi.paginators.ListAvailableResourceDimensionsIterable responses = client.listAvailableResourceDimensionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListAvailableResourceDimensionsRequest.builder()
listAvailableResourceDimensionsRequest - A Consumer that will call methods on ListAvailableResourceDimensionsRequest.Builder to
create a request.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.AwsServiceExceptiondefault 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.
listAvailableResourceMetricsRequest - 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.AwsServiceExceptiondefault 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 via ListAvailableResourceMetricsRequest.builder()
listAvailableResourceMetricsRequest - A Consumer that will call methods on ListAvailableResourceMetricsRequest.Builder to create
a request.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.AwsServiceExceptiondefault ListAvailableResourceMetricsIterable listAvailableResourceMetricsPaginator(ListAvailableResourceMetricsRequest 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 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 Stream
software.amazon.awssdk.services.pi.paginators.ListAvailableResourceMetricsIterable responses = client.listAvailableResourceMetricsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listAvailableResourceMetricsRequest - 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.AwsServiceExceptiondefault ListAvailableResourceMetricsIterable listAvailableResourceMetricsPaginator(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 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 Stream
software.amazon.awssdk.services.pi.paginators.ListAvailableResourceMetricsIterable responses = client.listAvailableResourceMetricsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListAvailableResourceMetricsRequest.builder()
listAvailableResourceMetricsRequest - A Consumer that will call methods on ListAvailableResourceMetricsRequest.Builder to create
a request.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.AwsServiceExceptionstatic PiClient create()
PiClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static PiClientBuilder builder()
PiClient.static ServiceMetadata serviceMetadata()
Copyright © 2023. All rights reserved.