Interface PiClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PiClient extends AwsClient
Service client for accessing AWS PI. This can be created using the staticbuilder()method.Amazon RDS Performance Insights Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.
When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for 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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreatePerformanceAnalysisReportRequest.builder()- Parameters:
createPerformanceAnalysisReportRequest- AConsumerthat will call methods onCreatePerformanceAnalysisReportRequest.Builderto create a request.- Returns:
- Result of the CreatePerformanceAnalysisReport operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeletePerformanceAnalysisReportRequest.builder()- Parameters:
deletePerformanceAnalysisReportRequest- AConsumerthat will call methods onDeletePerformanceAnalysisReportRequest.Builderto create a request.- Returns:
- Result of the DeletePerformanceAnalysisReport operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDimensionKeys
default DescribeDimensionKeysResponse describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException
For a specific time period, retrieve the top
Ndimension keys for a metric.Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
- Parameters:
describeDimensionKeysRequest-- Returns:
- Result of the DescribeDimensionKeys operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDimensionKeys
default DescribeDimensionKeysResponse describeDimensionKeys(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException
For a specific time period, retrieve the top
Ndimension 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.Builderavoiding the need to create one manually viaDescribeDimensionKeysRequest.builder()- Parameters:
describeDimensionKeysRequest- AConsumerthat will call methods onDescribeDimensionKeysRequest.Builderto create a request.- Returns:
- Result of the DescribeDimensionKeys operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeDimensionKeysRequest.builder()- Parameters:
describeDimensionKeysRequest- AConsumerthat will call methods onDescribeDimensionKeysRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDimensionKeyDetails
default GetDimensionKeyDetailsResponse getDimensionKeyDetails(GetDimensionKeyDetailsRequest getDimensionKeyDetailsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,
GetDimensionKeyDetailsretrieves the full text of the dimensiondb.sql.statementassociated with this ID. This operation is useful becauseGetResourceMetricsandDescribeDimensionKeysdon't support retrieval of large SQL statement text.- Parameters:
getDimensionKeyDetailsRequest-- Returns:
- Result of the GetDimensionKeyDetails operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDimensionKeyDetails
default GetDimensionKeyDetailsResponse getDimensionKeyDetails(Consumer<GetDimensionKeyDetailsRequest.Builder> getDimensionKeyDetailsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,
GetDimensionKeyDetailsretrieves the full text of the dimensiondb.sql.statementassociated with this ID. This operation is useful becauseGetResourceMetricsandDescribeDimensionKeysdon't support retrieval of large SQL statement text.
This is a convenience which creates an instance of the
GetDimensionKeyDetailsRequest.Builderavoiding the need to create one manually viaGetDimensionKeyDetailsRequest.builder()- Parameters:
getDimensionKeyDetailsRequest- AConsumerthat will call methods onGetDimensionKeyDetailsRequest.Builderto create a request.- Returns:
- Result of the GetDimensionKeyDetails operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 thedescriptionandrecommendationfields.- Parameters:
getPerformanceAnalysisReportRequest-- Returns:
- Result of the GetPerformanceAnalysisReport operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 thedescriptionandrecommendationfields.
This is a convenience which creates an instance of the
GetPerformanceAnalysisReportRequest.Builderavoiding the need to create one manually viaGetPerformanceAnalysisReportRequest.builder()- Parameters:
getPerformanceAnalysisReportRequest- AConsumerthat will call methods onGetPerformanceAnalysisReportRequest.Builderto create a request.- Returns:
- Result of the GetPerformanceAnalysisReport operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetResourceMetadataRequest.builder()- Parameters:
getResourceMetadataRequest- AConsumerthat will call methods onGetResourceMetadataRequest.Builderto create a request.- Returns:
- Result of the GetResourceMetadata operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceMetrics
default GetResourceMetricsResponse getResourceMetrics(GetResourceMetricsRequest getResourceMetricsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException
Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide 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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceMetrics
default GetResourceMetricsResponse getResourceMetrics(Consumer<GetResourceMetricsRequest.Builder> getResourceMetricsRequest) throws InvalidArgumentException, InternalServiceErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, PiException
Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide 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.Builderavoiding the need to create one manually viaGetResourceMetricsRequest.builder()- Parameters:
getResourceMetricsRequest- AConsumerthat will call methods onGetResourceMetricsRequest.Builderto create a request.- Returns:
- Result of the GetResourceMetrics operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetResourceMetricsRequest.builder()- Parameters:
getResourceMetricsRequest- AConsumerthat will call methods onGetResourceMetricsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAvailableResourceDimensionsRequest.builder()- Parameters:
listAvailableResourceDimensionsRequest- AConsumerthat will call methods onListAvailableResourceDimensionsRequest.Builderto create a request.- Returns:
- Result of the ListAvailableResourceDimensions operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListAvailableResourceDimensionsRequest.builder()- Parameters:
listAvailableResourceDimensionsRequest- AConsumerthat will call methods onListAvailableResourceDimensionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAvailableResourceMetricsRequest.builder()- Parameters:
listAvailableResourceMetricsRequest- AConsumerthat will call methods onListAvailableResourceMetricsRequest.Builderto create a request.- Returns:
- Result of the ListAvailableResourceMetrics operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListAvailableResourceMetricsRequest.builder()- Parameters:
listAvailableResourceMetricsRequest- AConsumerthat will call methods onListAvailableResourceMetricsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListPerformanceAnalysisReportsRequest.builder()- Parameters:
listPerformanceAnalysisReportsRequest- AConsumerthat will call methods onListPerformanceAnalysisReportsRequest.Builderto create a request.- Returns:
- Result of the ListPerformanceAnalysisReports operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListPerformanceAnalysisReportsRequest.builder()- Parameters:
listPerformanceAnalysisReportsRequest- AConsumerthat will call methods onListPerformanceAnalysisReportsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InvalidArgumentException- One of the arguments provided is invalid for this request.InternalServiceErrorException- The request failed due to an unknown error.NotAuthorizedException- The user is not authorized to perform this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.PiException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static PiClient create()
Create aPiClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static PiClientBuilder builder()
Create a builder that can be used to configure and create aPiClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default PiServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-