@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ApplicationCostProfilerClient extends SdkClient
builder()
method.
This reference provides descriptions of the AWS Application Cost Profiler API.
The AWS Application Cost Profiler API provides programmatic access to view, create, update, and delete application cost report definitions, as well as to import your usage data into the Application Cost Profiler service.
For more information about using this service, see the AWS Application Cost Profiler User 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 ApplicationCostProfilerClientBuilder |
builder()
Create a builder that can be used to configure and create a
ApplicationCostProfilerClient. |
static ApplicationCostProfilerClient |
create()
Create a
ApplicationCostProfilerClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default DeleteReportDefinitionResponse |
deleteReportDefinition(Consumer<DeleteReportDefinitionRequest.Builder> deleteReportDefinitionRequest)
Deletes the specified report definition in AWS Application Cost Profiler.
|
default DeleteReportDefinitionResponse |
deleteReportDefinition(DeleteReportDefinitionRequest deleteReportDefinitionRequest)
Deletes the specified report definition in AWS Application Cost Profiler.
|
default GetReportDefinitionResponse |
getReportDefinition(Consumer<GetReportDefinitionRequest.Builder> getReportDefinitionRequest)
Retrieves the definition of a report already configured in AWS Application Cost Profiler.
|
default GetReportDefinitionResponse |
getReportDefinition(GetReportDefinitionRequest getReportDefinitionRequest)
Retrieves the definition of a report already configured in AWS Application Cost Profiler.
|
default ImportApplicationUsageResponse |
importApplicationUsage(Consumer<ImportApplicationUsageRequest.Builder> importApplicationUsageRequest)
Ingests application usage data from Amazon Simple Storage Service (Amazon S3).
|
default ImportApplicationUsageResponse |
importApplicationUsage(ImportApplicationUsageRequest importApplicationUsageRequest)
Ingests application usage data from Amazon Simple Storage Service (Amazon S3).
|
default ListReportDefinitionsResponse |
listReportDefinitions(Consumer<ListReportDefinitionsRequest.Builder> listReportDefinitionsRequest)
Retrieves a list of all reports and their configurations for your AWS account.
|
default ListReportDefinitionsResponse |
listReportDefinitions(ListReportDefinitionsRequest listReportDefinitionsRequest)
Retrieves a list of all reports and their configurations for your AWS account.
|
default ListReportDefinitionsIterable |
listReportDefinitionsPaginator(Consumer<ListReportDefinitionsRequest.Builder> listReportDefinitionsRequest)
Retrieves a list of all reports and their configurations for your AWS account.
|
default ListReportDefinitionsIterable |
listReportDefinitionsPaginator(ListReportDefinitionsRequest listReportDefinitionsRequest)
Retrieves a list of all reports and their configurations for your AWS account.
|
default PutReportDefinitionResponse |
putReportDefinition(Consumer<PutReportDefinitionRequest.Builder> putReportDefinitionRequest)
Creates the report definition for a report in Application Cost Profiler.
|
default PutReportDefinitionResponse |
putReportDefinition(PutReportDefinitionRequest putReportDefinitionRequest)
Creates the report definition for a report in Application Cost Profiler.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateReportDefinitionResponse |
updateReportDefinition(Consumer<UpdateReportDefinitionRequest.Builder> updateReportDefinitionRequest)
Updates existing report in AWS Application Cost Profiler.
|
default UpdateReportDefinitionResponse |
updateReportDefinition(UpdateReportDefinitionRequest updateReportDefinitionRequest)
Updates existing report in AWS Application Cost Profiler.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static ApplicationCostProfilerClient create()
ApplicationCostProfilerClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ApplicationCostProfilerClientBuilder builder()
ApplicationCostProfilerClient.default DeleteReportDefinitionResponse deleteReportDefinition(DeleteReportDefinitionRequest deleteReportDefinitionRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being generated.
deleteReportDefinitionRequest - InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteReportDefinitionResponse deleteReportDefinition(Consumer<DeleteReportDefinitionRequest.Builder> deleteReportDefinitionRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being generated.
This is a convenience which creates an instance of the DeleteReportDefinitionRequest.Builder avoiding the
need to create one manually via DeleteReportDefinitionRequest.builder()
deleteReportDefinitionRequest - A Consumer that will call methods on DeleteReportDefinitionRequest.Builder to create a
request.InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetReportDefinitionResponse getReportDefinition(GetReportDefinitionRequest getReportDefinitionRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Retrieves the definition of a report already configured in AWS Application Cost Profiler.
getReportDefinitionRequest - InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetReportDefinitionResponse getReportDefinition(Consumer<GetReportDefinitionRequest.Builder> getReportDefinitionRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Retrieves the definition of a report already configured in AWS Application Cost Profiler.
This is a convenience which creates an instance of the GetReportDefinitionRequest.Builder avoiding the
need to create one manually via GetReportDefinitionRequest.builder()
getReportDefinitionRequest - A Consumer that will call methods on GetReportDefinitionRequest.Builder to create a
request.InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportApplicationUsageResponse importApplicationUsage(ImportApplicationUsageRequest importApplicationUsageRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Ingests application usage data from Amazon Simple Storage Service (Amazon S3).
The data must already exist in the S3 location. As part of the action, AWS Application Cost Profiler copies the object from your S3 bucket to an S3 bucket owned by Amazon for processing asynchronously.
importApplicationUsageRequest - InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportApplicationUsageResponse importApplicationUsage(Consumer<ImportApplicationUsageRequest.Builder> importApplicationUsageRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Ingests application usage data from Amazon Simple Storage Service (Amazon S3).
The data must already exist in the S3 location. As part of the action, AWS Application Cost Profiler copies the object from your S3 bucket to an S3 bucket owned by Amazon for processing asynchronously.
This is a convenience which creates an instance of the ImportApplicationUsageRequest.Builder avoiding the
need to create one manually via ImportApplicationUsageRequest.builder()
importApplicationUsageRequest - A Consumer that will call methods on ImportApplicationUsageRequest.Builder to create a
request.InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReportDefinitionsResponse listReportDefinitions(ListReportDefinitionsRequest listReportDefinitionsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Retrieves a list of all reports and their configurations for your AWS account.
The maximum number of reports is one.
listReportDefinitionsRequest - InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReportDefinitionsResponse listReportDefinitions(Consumer<ListReportDefinitionsRequest.Builder> listReportDefinitionsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Retrieves a list of all reports and their configurations for your AWS account.
The maximum number of reports is one.
This is a convenience which creates an instance of the ListReportDefinitionsRequest.Builder avoiding the
need to create one manually via ListReportDefinitionsRequest.builder()
listReportDefinitionsRequest - A Consumer that will call methods on ListReportDefinitionsRequest.Builder to create a
request.InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReportDefinitionsIterable listReportDefinitionsPaginator(ListReportDefinitionsRequest listReportDefinitionsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Retrieves a list of all reports and their configurations for your AWS account.
The maximum number of reports is one.
This is a variant of
listReportDefinitions(software.amazon.awssdk.services.applicationcostprofiler.model.ListReportDefinitionsRequest)
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.applicationcostprofiler.paginators.ListReportDefinitionsIterable responses = client.listReportDefinitionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.applicationcostprofiler.paginators.ListReportDefinitionsIterable responses = client
.listReportDefinitionsPaginator(request);
for (software.amazon.awssdk.services.applicationcostprofiler.model.ListReportDefinitionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.applicationcostprofiler.paginators.ListReportDefinitionsIterable responses = client.listReportDefinitionsPaginator(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
listReportDefinitions(software.amazon.awssdk.services.applicationcostprofiler.model.ListReportDefinitionsRequest)
operation.
listReportDefinitionsRequest - InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReportDefinitionsIterable listReportDefinitionsPaginator(Consumer<ListReportDefinitionsRequest.Builder> listReportDefinitionsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Retrieves a list of all reports and their configurations for your AWS account.
The maximum number of reports is one.
This is a variant of
listReportDefinitions(software.amazon.awssdk.services.applicationcostprofiler.model.ListReportDefinitionsRequest)
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.applicationcostprofiler.paginators.ListReportDefinitionsIterable responses = client.listReportDefinitionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.applicationcostprofiler.paginators.ListReportDefinitionsIterable responses = client
.listReportDefinitionsPaginator(request);
for (software.amazon.awssdk.services.applicationcostprofiler.model.ListReportDefinitionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.applicationcostprofiler.paginators.ListReportDefinitionsIterable responses = client.listReportDefinitionsPaginator(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
listReportDefinitions(software.amazon.awssdk.services.applicationcostprofiler.model.ListReportDefinitionsRequest)
operation.
This is a convenience which creates an instance of the ListReportDefinitionsRequest.Builder avoiding the
need to create one manually via ListReportDefinitionsRequest.builder()
listReportDefinitionsRequest - A Consumer that will call methods on ListReportDefinitionsRequest.Builder to create a
request.InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutReportDefinitionResponse putReportDefinition(PutReportDefinitionRequest putReportDefinitionRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Creates the report definition for a report in Application Cost Profiler.
putReportDefinitionRequest - InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.ServiceQuotaExceededException - Your request exceeds one or more of the service quotas.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutReportDefinitionResponse putReportDefinition(Consumer<PutReportDefinitionRequest.Builder> putReportDefinitionRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Creates the report definition for a report in Application Cost Profiler.
This is a convenience which creates an instance of the PutReportDefinitionRequest.Builder avoiding the
need to create one manually via PutReportDefinitionRequest.builder()
putReportDefinitionRequest - A Consumer that will call methods on PutReportDefinitionRequest.Builder to create a
request.InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.ServiceQuotaExceededException - Your request exceeds one or more of the service quotas.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateReportDefinitionResponse updateReportDefinition(UpdateReportDefinitionRequest updateReportDefinitionRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Updates existing report in AWS Application Cost Profiler.
updateReportDefinitionRequest - InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateReportDefinitionResponse updateReportDefinition(Consumer<UpdateReportDefinitionRequest.Builder> updateReportDefinitionRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException
Updates existing report in AWS Application Cost Profiler.
This is a convenience which creates an instance of the UpdateReportDefinitionRequest.Builder avoiding the
need to create one manually via UpdateReportDefinitionRequest.builder()
updateReportDefinitionRequest - A Consumer that will call methods on UpdateReportDefinitionRequest.Builder to create a
request.InternalServerException - An internal server error occurred. Retry your request.ThrottlingException - The calls to AWS Application Cost Profiler API are throttled. The request was denied.ValidationException - The input fails to satisfy the constraints for the API.AccessDeniedException - You do not have permission to perform this action.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.ApplicationCostProfilerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2021. All rights reserved.