Interface ApplicationCostProfilerClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aApplicationCostProfilerClient
.create()
Create aApplicationCostProfilerClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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) This is a variant oflistReportDefinitions(software.amazon.awssdk.services.applicationcostprofiler.model.ListReportDefinitionsRequest)
operation.default ListReportDefinitionsIterable
listReportDefinitionsPaginator
(ListReportDefinitionsRequest listReportDefinitionsRequest) This is a variant oflistReportDefinitions(software.amazon.awssdk.services.applicationcostprofiler.model.ListReportDefinitionsRequest)
operation.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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
deleteReportDefinition
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.
- Parameters:
deleteReportDefinitionRequest
-- Returns:
- Result of the DeleteReportDefinition operation returned by the service.
- See Also:
-
deleteReportDefinition
default 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 viaDeleteReportDefinitionRequest.builder()
- Parameters:
deleteReportDefinitionRequest
- AConsumer
that will call methods onDeleteReportDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeleteReportDefinition operation returned by the service.
- See Also:
-
getReportDefinition
default 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.
- Parameters:
getReportDefinitionRequest
-- Returns:
- Result of the GetReportDefinition operation returned by the service.
- See Also:
-
getReportDefinition
default 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 viaGetReportDefinitionRequest.builder()
- Parameters:
getReportDefinitionRequest
- AConsumer
that will call methods onGetReportDefinitionRequest.Builder
to create a request.- Returns:
- Result of the GetReportDefinition operation returned by the service.
- See Also:
-
importApplicationUsage
default 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.
- Parameters:
importApplicationUsageRequest
-- Returns:
- Result of the ImportApplicationUsage operation returned by the service.
- See Also:
-
importApplicationUsage
default 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 viaImportApplicationUsageRequest.builder()
- Parameters:
importApplicationUsageRequest
- AConsumer
that will call methods onImportApplicationUsageRequest.Builder
to create a request.- Returns:
- Result of the ImportApplicationUsage operation returned by the service.
- See Also:
-
listReportDefinitions
default 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.
- Parameters:
listReportDefinitionsRequest
-- Returns:
- Result of the ListReportDefinitions operation returned by the service.
- See Also:
-
listReportDefinitions
default 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 viaListReportDefinitionsRequest.builder()
- Parameters:
listReportDefinitionsRequest
- AConsumer
that will call methods onListReportDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListReportDefinitions operation returned by the service.
- See Also:
-
listReportDefinitionsPaginator
default ListReportDefinitionsIterable listReportDefinitionsPaginator(ListReportDefinitionsRequest listReportDefinitionsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException 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 Streamsoftware.amazon.awssdk.services.applicationcostprofiler.paginators.ListReportDefinitionsIterable responses = client.listReportDefinitionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listReportDefinitionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReportDefinitionsPaginator
default ListReportDefinitionsIterable listReportDefinitionsPaginator(Consumer<ListReportDefinitionsRequest.Builder> listReportDefinitionsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException 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 Streamsoftware.amazon.awssdk.services.applicationcostprofiler.paginators.ListReportDefinitionsIterable responses = client.listReportDefinitionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListReportDefinitionsRequest.builder()
- Parameters:
listReportDefinitionsRequest
- AConsumer
that will call methods onListReportDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putReportDefinition
default PutReportDefinitionResponse putReportDefinition(PutReportDefinitionRequest putReportDefinitionRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ApplicationCostProfilerException Creates the report definition for a report in Application Cost Profiler.
- Parameters:
putReportDefinitionRequest
-- Returns:
- Result of the PutReportDefinition operation returned by the service.
- See Also:
-
putReportDefinition
default 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 viaPutReportDefinitionRequest.builder()
- Parameters:
putReportDefinitionRequest
- AConsumer
that will call methods onPutReportDefinitionRequest.Builder
to create a request.- Returns:
- Result of the PutReportDefinition operation returned by the service.
- See Also:
-
updateReportDefinition
default UpdateReportDefinitionResponse updateReportDefinition(UpdateReportDefinitionRequest updateReportDefinitionRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ApplicationCostProfilerException Updates existing report in AWS Application Cost Profiler.
- Parameters:
updateReportDefinitionRequest
-- Returns:
- Result of the UpdateReportDefinition operation returned by the service.
- See Also:
-
updateReportDefinition
default 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 viaUpdateReportDefinitionRequest.builder()
- Parameters:
updateReportDefinitionRequest
- AConsumer
that will call methods onUpdateReportDefinitionRequest.Builder
to create a request.- Returns:
- Result of the UpdateReportDefinition operation returned by the service.
- See Also:
-
create
Create aApplicationCostProfilerClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aApplicationCostProfilerClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-