Interface ApplicationCostProfilerClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface ApplicationCostProfilerClient
extends AwsClient

Service client for accessing AWS Application Cost Profiler. This can be created using the static 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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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)	This is a variant of listReportDefinitions(software.amazon.awssdk.services.applicationcostprofiler.model.ListReportDefinitionsRequest) operation.
default ListReportDefinitionsIterable	listReportDefinitionsPaginator(ListReportDefinitionsRequest listReportDefinitionsRequest)	This is a variant of listReportDefinitions(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.
default ApplicationCostProfilerServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
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.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

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 the ServiceMetadataProvider.

See Also:

• Constant Field Values

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:

• AWS API Documentation

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 via DeleteReportDefinitionRequest.builder()

Parameters:

deleteReportDefinitionRequest - A Consumer that will call methods on DeleteReportDefinitionRequest.Builder to create a request.

Returns:

Result of the DeleteReportDefinition operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetReportDefinitionRequest.builder()

Parameters:

getReportDefinitionRequest - A Consumer that will call methods on GetReportDefinitionRequest.Builder to create a request.

Returns:

Result of the GetReportDefinition operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ImportApplicationUsageRequest.builder()

Parameters:

importApplicationUsageRequest - A Consumer that will call methods on ImportApplicationUsageRequest.Builder to create a request.

Returns:

Result of the ImportApplicationUsage operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListReportDefinitionsRequest.builder()

Parameters:

listReportDefinitionsRequest - A Consumer that will call methods on ListReportDefinitionsRequest.Builder to create a request.

Returns:

Result of the ListReportDefinitions operation returned by the service.

See Also:

• AWS API Documentation

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 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.

Parameters:

listReportDefinitionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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 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()

Parameters:

listReportDefinitionsRequest - A Consumer that will call methods on ListReportDefinitionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via PutReportDefinitionRequest.builder()

Parameters:

putReportDefinitionRequest - A Consumer that will call methods on PutReportDefinitionRequest.Builder to create a request.

Returns:

Result of the PutReportDefinition operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateReportDefinitionRequest.builder()

Parameters:

updateReportDefinitionRequest - A Consumer that will call methods on UpdateReportDefinitionRequest.Builder to create a request.

Returns:

Result of the UpdateReportDefinition operation returned by the service.

See Also:

• AWS API Documentation

create

static ApplicationCostProfilerClient create()

Create a ApplicationCostProfilerClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ApplicationCostProfilerClientBuilder builder()

Create a builder that can be used to configure and create a ApplicationCostProfilerClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ApplicationCostProfilerServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration