software.amazon.awssdk.services.costexplorer

Interface CostExplorerAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface CostExplorerAsyncClient
extends SdkClient

Service client for accessing AWS Cost Explorer asynchronously. This can be created using the static builder() method.

The Cost Explorer API allows you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.

Service Endpoint

The Cost Explorer API provides the following endpoint:

• https://ce.us-east-1.amazonaws.com

For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static CostExplorerAsyncClientBuilder	builder() Create a builder that can be used to configure and create a CostExplorerAsyncClient.
static CostExplorerAsyncClient	create() Create a CostExplorerAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<GetCostAndUsageResponse>	getCostAndUsage(Consumer<GetCostAndUsageRequest.Builder> getCostAndUsageRequest) Retrieves cost and usage metrics for your account.
default CompletableFuture<GetCostAndUsageResponse>	getCostAndUsage(GetCostAndUsageRequest getCostAndUsageRequest) Retrieves cost and usage metrics for your account.
default CompletableFuture<GetCostForecastResponse>	getCostForecast(Consumer<GetCostForecastRequest.Builder> getCostForecastRequest) Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.
default CompletableFuture<GetCostForecastResponse>	getCostForecast(GetCostForecastRequest getCostForecastRequest) Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.
default CompletableFuture<GetDimensionValuesResponse>	getDimensionValues(Consumer<GetDimensionValuesRequest.Builder> getDimensionValuesRequest) Retrieves all available filter values for a specified filter over a period of time.
default CompletableFuture<GetDimensionValuesResponse>	getDimensionValues(GetDimensionValuesRequest getDimensionValuesRequest) Retrieves all available filter values for a specified filter over a period of time.
default CompletableFuture<GetReservationCoverageResponse>	getReservationCoverage(Consumer<GetReservationCoverageRequest.Builder> getReservationCoverageRequest) Retrieves the reservation coverage for your account.
default CompletableFuture<GetReservationCoverageResponse>	getReservationCoverage(GetReservationCoverageRequest getReservationCoverageRequest) Retrieves the reservation coverage for your account.
default CompletableFuture<GetReservationPurchaseRecommendationResponse>	getReservationPurchaseRecommendation(Consumer<GetReservationPurchaseRecommendationRequest.Builder> getReservationPurchaseRecommendationRequest) Gets recommendations for which reservations to purchase.
default CompletableFuture<GetReservationPurchaseRecommendationResponse>	getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest getReservationPurchaseRecommendationRequest) Gets recommendations for which reservations to purchase.
default CompletableFuture<GetReservationUtilizationResponse>	getReservationUtilization(Consumer<GetReservationUtilizationRequest.Builder> getReservationUtilizationRequest) Retrieves the reservation utilization for your account.
default CompletableFuture<GetReservationUtilizationResponse>	getReservationUtilization(GetReservationUtilizationRequest getReservationUtilizationRequest) Retrieves the reservation utilization for your account.
default CompletableFuture<GetTagsResponse>	getTags(Consumer<GetTagsRequest.Builder> getTagsRequest) Queries for available tag keys and tag values for a specified period.
default CompletableFuture<GetTagsResponse>	getTags(GetTagsRequest getTagsRequest) Queries for available tag keys and tag values for a specified period.

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

serviceName

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

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static CostExplorerAsyncClient create()

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

builder

static CostExplorerAsyncClientBuilder builder()

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

getCostAndUsage

default CompletableFuture<GetCostAndUsageResponse> getCostAndUsage(GetCostAndUsageRequest getCostAndUsageRequest)

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.

Parameters:

getCostAndUsageRequest -

Returns:

A Java Future containing the result of the GetCostAndUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• BillExpirationException The requested report expired. Update the date interval and try again.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• RequestChangedException Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getCostAndUsage

default CompletableFuture<GetCostAndUsageResponse> getCostAndUsage(Consumer<GetCostAndUsageRequest.Builder> getCostAndUsageRequest)

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.

This is a convenience which creates an instance of the GetCostAndUsageRequest.Builder avoiding the need to create one manually via GetCostAndUsageRequest.builder()

Parameters:

getCostAndUsageRequest - A Consumer that will call methods on GetCostAndUsageRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetCostAndUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• BillExpirationException The requested report expired. Update the date interval and try again.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• RequestChangedException Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getCostForecast

default CompletableFuture<GetCostForecastResponse> getCostForecast(GetCostForecastRequest getCostForecastRequest)

Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.

Parameters:

getCostForecastRequest -

Returns:

A Java Future containing the result of the GetCostForecast operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• DataUnavailableException The requested data is unavailable.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getCostForecast

default CompletableFuture<GetCostForecastResponse> getCostForecast(Consumer<GetCostForecastRequest.Builder> getCostForecastRequest)

Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.

This is a convenience which creates an instance of the GetCostForecastRequest.Builder avoiding the need to create one manually via GetCostForecastRequest.builder()

Parameters:

getCostForecastRequest - A Consumer that will call methods on GetCostForecastRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetCostForecast operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• DataUnavailableException The requested data is unavailable.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getDimensionValues

default CompletableFuture<GetDimensionValuesResponse> getDimensionValues(GetDimensionValuesRequest getDimensionValuesRequest)

Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.

Parameters:

getDimensionValuesRequest -

Returns:

A Java Future containing the result of the GetDimensionValues operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• BillExpirationException The requested report expired. Update the date interval and try again.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• RequestChangedException Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getDimensionValues

default CompletableFuture<GetDimensionValuesResponse> getDimensionValues(Consumer<GetDimensionValuesRequest.Builder> getDimensionValuesRequest)

Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.

This is a convenience which creates an instance of the GetDimensionValuesRequest.Builder avoiding the need to create one manually via GetDimensionValuesRequest.builder()

Parameters:

getDimensionValuesRequest - A Consumer that will call methods on GetDimensionValuesRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetDimensionValues operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• BillExpirationException The requested report expired. Update the date interval and try again.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• RequestChangedException Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getReservationCoverage

default CompletableFuture<GetReservationCoverageResponse> getReservationCoverage(GetReservationCoverageRequest getReservationCoverageRequest)

Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• TAG

• TENANCY

To determine valid values for a dimension, use the GetDimensionValues operation.

Parameters:

getReservationCoverageRequest - You can use the following request parameters to query for how much of your instance usage is covered by a reservation.

Returns:

A Java Future containing the result of the GetReservationCoverage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getReservationCoverage

default CompletableFuture<GetReservationCoverageResponse> getReservationCoverage(Consumer<GetReservationCoverageRequest.Builder> getReservationCoverageRequest)

Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• TAG

• TENANCY

To determine valid values for a dimension, use the GetDimensionValues operation.

This is a convenience which creates an instance of the GetReservationCoverageRequest.Builder avoiding the need to create one manually via GetReservationCoverageRequest.builder()

Parameters:

getReservationCoverageRequest - A Consumer that will call methods on GetReservationCoverageRequest.Builder to create a request. You can use the following request parameters to query for how much of your instance usage is covered by a reservation.

Returns:

A Java Future containing the result of the GetReservationCoverage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getReservationPurchaseRecommendation

default CompletableFuture<GetReservationPurchaseRecommendationResponse> getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest getReservationPurchaseRecommendationRequest)

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large, because that is the smallest size instance in the c4 instance family.

Parameters:

getReservationPurchaseRecommendationRequest -

Returns:

A Java Future containing the result of the GetReservationPurchaseRecommendation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getReservationPurchaseRecommendation

default CompletableFuture<GetReservationPurchaseRecommendationResponse> getReservationPurchaseRecommendation(Consumer<GetReservationPurchaseRecommendationRequest.Builder> getReservationPurchaseRecommendationRequest)

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large, because that is the smallest size instance in the c4 instance family.

This is a convenience which creates an instance of the GetReservationPurchaseRecommendationRequest.Builder avoiding the need to create one manually via GetReservationPurchaseRecommendationRequest.builder()

Parameters:

getReservationPurchaseRecommendationRequest - A Consumer that will call methods on GetReservationPurchaseRecommendationRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetReservationPurchaseRecommendation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getReservationUtilization

default CompletableFuture<GetReservationUtilizationResponse> getReservationUtilization(GetReservationUtilizationRequest getReservationUtilizationRequest)

Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.

Parameters:

getReservationUtilizationRequest -

Returns:

A Java Future containing the result of the GetReservationUtilization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getReservationUtilization

default CompletableFuture<GetReservationUtilizationResponse> getReservationUtilization(Consumer<GetReservationUtilizationRequest.Builder> getReservationUtilizationRequest)

Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.

This is a convenience which creates an instance of the GetReservationUtilizationRequest.Builder avoiding the need to create one manually via GetReservationUtilizationRequest.builder()

Parameters:

getReservationUtilizationRequest - A Consumer that will call methods on GetReservationUtilizationRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetReservationUtilization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getTags

default CompletableFuture<GetTagsResponse> getTags(GetTagsRequest getTagsRequest)

Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.

Parameters:

getTagsRequest -

Returns:

A Java Future containing the result of the GetTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• BillExpirationException The requested report expired. Update the date interval and try again.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• RequestChangedException Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getTags

default CompletableFuture<GetTagsResponse> getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)

Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.

This is a convenience which creates an instance of the GetTagsRequest.Builder avoiding the need to create one manually via GetTagsRequest.builder()

Parameters:

getTagsRequest - A Consumer that will call methods on GetTagsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException You made too many calls in a short period of time. Try again later.
• BillExpirationException The requested report expired. Update the date interval and try again.
• DataUnavailableException The requested data is unavailable.
• InvalidNextTokenException The pagination token is invalid. Try again without a pagination token.
• RequestChangedException Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
• 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.
• CostExplorerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation