@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCostExplorerAsyncClient extends AWSCostExplorerClient implements AWSCostExplorerAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
The Cost Explorer API enables 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.
configFactory
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
builder, getCachedResponseMetadata, getCostAndUsage, getCostForecast, getDimensionValues, getReservationCoverage, getReservationPurchaseRecommendation, getReservationUtilization, getRightsizingRecommendation, getTags, getUsageForecast
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCachedResponseMetadata, getCostAndUsage, getCostForecast, getDimensionValues, getReservationCoverage, getReservationPurchaseRecommendation, getReservationUtilization, getRightsizingRecommendation, getTags, getUsageForecast
public static AWSCostExplorerAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<GetCostAndUsageResult> getCostAndUsageAsync(GetCostAndUsageRequest request)
AWSCostExplorerAsync
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.
getCostAndUsageAsync
in interface AWSCostExplorerAsync
public Future<GetCostAndUsageResult> getCostAndUsageAsync(GetCostAndUsageRequest request, AsyncHandler<GetCostAndUsageRequest,GetCostAndUsageResult> asyncHandler)
AWSCostExplorerAsync
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.
getCostAndUsageAsync
in interface AWSCostExplorerAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCostForecastResult> getCostForecastAsync(GetCostForecastRequest request)
AWSCostExplorerAsync
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.
getCostForecastAsync
in interface AWSCostExplorerAsync
public Future<GetCostForecastResult> getCostForecastAsync(GetCostForecastRequest request, AsyncHandler<GetCostForecastRequest,GetCostForecastResult> asyncHandler)
AWSCostExplorerAsync
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.
getCostForecastAsync
in interface AWSCostExplorerAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDimensionValuesResult> getDimensionValuesAsync(GetDimensionValuesRequest request)
AWSCostExplorerAsync
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
getDimensionValuesAsync
in interface AWSCostExplorerAsync
public Future<GetDimensionValuesResult> getDimensionValuesAsync(GetDimensionValuesRequest request, AsyncHandler<GetDimensionValuesRequest,GetDimensionValuesResult> asyncHandler)
AWSCostExplorerAsync
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
getDimensionValuesAsync
in interface AWSCostExplorerAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetReservationCoverageResult> getReservationCoverageAsync(GetReservationCoverageRequest request)
AWSCostExplorerAsync
Retrieves the reservation coverage for your account. This enables 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.
getReservationCoverageAsync
in interface AWSCostExplorerAsync
request
- You can use the following request parameters to query for how much of your instance usage a reservation
covered.public Future<GetReservationCoverageResult> getReservationCoverageAsync(GetReservationCoverageRequest request, AsyncHandler<GetReservationCoverageRequest,GetReservationCoverageResult> asyncHandler)
AWSCostExplorerAsync
Retrieves the reservation coverage for your account. This enables 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.
getReservationCoverageAsync
in interface AWSCostExplorerAsync
request
- You can use the following request parameters to query for how much of your instance usage a reservation
covered.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetReservationPurchaseRecommendationResult> getReservationPurchaseRecommendationAsync(GetReservationPurchaseRecommendationRequest request)
AWSCostExplorerAsync
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 Amazon 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.
getReservationPurchaseRecommendationAsync
in interface AWSCostExplorerAsync
public Future<GetReservationPurchaseRecommendationResult> getReservationPurchaseRecommendationAsync(GetReservationPurchaseRecommendationRequest request, AsyncHandler<GetReservationPurchaseRecommendationRequest,GetReservationPurchaseRecommendationResult> asyncHandler)
AWSCostExplorerAsync
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 Amazon 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.
getReservationPurchaseRecommendationAsync
in interface AWSCostExplorerAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetReservationUtilizationResult> getReservationUtilizationAsync(GetReservationUtilizationRequest request)
AWSCostExplorerAsync
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
.
getReservationUtilizationAsync
in interface AWSCostExplorerAsync
public Future<GetReservationUtilizationResult> getReservationUtilizationAsync(GetReservationUtilizationRequest request, AsyncHandler<GetReservationUtilizationRequest,GetReservationUtilizationResult> asyncHandler)
AWSCostExplorerAsync
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
.
getReservationUtilizationAsync
in interface AWSCostExplorerAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetRightsizingRecommendationResult> getRightsizingRecommendationAsync(GetRightsizingRecommendationRequest request)
AWSCostExplorerAsync
Creates recommendations that helps you save cost by identifying idle and underutilized Amazon EC2 instances.
Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations.
getRightsizingRecommendationAsync
in interface AWSCostExplorerAsync
public Future<GetRightsizingRecommendationResult> getRightsizingRecommendationAsync(GetRightsizingRecommendationRequest request, AsyncHandler<GetRightsizingRecommendationRequest,GetRightsizingRecommendationResult> asyncHandler)
AWSCostExplorerAsync
Creates recommendations that helps you save cost by identifying idle and underutilized Amazon EC2 instances.
Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations.
getRightsizingRecommendationAsync
in interface AWSCostExplorerAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetTagsResult> getTagsAsync(GetTagsRequest request)
AWSCostExplorerAsync
Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
getTagsAsync
in interface AWSCostExplorerAsync
public Future<GetTagsResult> getTagsAsync(GetTagsRequest request, AsyncHandler<GetTagsRequest,GetTagsResult> asyncHandler)
AWSCostExplorerAsync
Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
getTagsAsync
in interface AWSCostExplorerAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetUsageForecastResult> getUsageForecastAsync(GetUsageForecastRequest request)
AWSCostExplorerAsync
Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.
getUsageForecastAsync
in interface AWSCostExplorerAsync
public Future<GetUsageForecastResult> getUsageForecastAsync(GetUsageForecastRequest request, AsyncHandler<GetUsageForecastRequest,GetUsageForecastResult> asyncHandler)
AWSCostExplorerAsync
Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.
getUsageForecastAsync
in interface AWSCostExplorerAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AWSCostExplorer
shutdown
in class AmazonWebServiceClient
Copyright © 2019. All rights reserved.