com.amazonaws.services.costexplorer

Class AWSCostExplorerClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.costexplorer.AWSCostExplorerClient

All Implemented Interfaces:

AWSCostExplorer

Direct Known Subclasses:

AWSCostExplorerAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSCostExplorerClient
extends AmazonWebServiceClient
implements AWSCostExplorer

Client for accessing AWS Cost Explorer. All service calls made using this client are blocking, and will not return until the service call 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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.costexplorer.AWSCostExplorer

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSCostExplorerClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetCostAndUsageResult	getCostAndUsage(GetCostAndUsageRequest request) Retrieves cost and usage metrics for your account.
GetCostForecastResult	getCostForecast(GetCostForecastRequest request) 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.
GetDimensionValuesResult	getDimensionValues(GetDimensionValuesRequest request) Retrieves all available filter values for a specified filter over a period of time.
GetReservationCoverageResult	getReservationCoverage(GetReservationCoverageRequest request) Retrieves the reservation coverage for your account.
GetReservationPurchaseRecommendationResult	getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest request) Gets recommendations for which reservations to purchase.
GetReservationUtilizationResult	getReservationUtilization(GetReservationUtilizationRequest request) Retrieves the reservation utilization for your account.
GetRightsizingRecommendationResult	getRightsizingRecommendation(GetRightsizingRecommendationRequest request) Creates recommendations that helps you save cost by identifying idle and underutilized Amazon EC2 instances.
GetTagsResult	getTags(GetTagsRequest request) Queries for available tag keys and tag values for a specified period.
GetUsageForecastResult	getUsageForecast(GetUsageForecastRequest request) 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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.costexplorer.AWSCostExplorer

shutdown

Method Detail

builder

public static AWSCostExplorerClientBuilder builder()

getCostAndUsage

public GetCostAndUsageResult getCostAndUsage(GetCostAndUsageRequest request)

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.

Specified by:

getCostAndUsage in interface AWSCostExplorer

Parameters:

getCostAndUsageRequest -

Returns:

Result of the GetCostAndUsage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCostForecast

public GetCostForecastResult getCostForecast(GetCostForecastRequest request)

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.

Specified by:

getCostForecast in interface AWSCostExplorer

Parameters:

getCostForecastRequest -

Returns:

Result of the GetCostForecast operation returned by the service.

Throws:

LimitExceededException - You made too many calls in a short period of time. Try again later.

DataUnavailableException - The requested data is unavailable.

See Also:

AWS API Documentation

getDimensionValues

public GetDimensionValuesResult getDimensionValues(GetDimensionValuesRequest request)

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

Specified by:

getDimensionValues in interface AWSCostExplorer

Parameters:

getDimensionValuesRequest -

Returns:

Result of the GetDimensionValues operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getReservationCoverage

public GetReservationCoverageResult getReservationCoverage(GetReservationCoverageRequest request)

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.

Specified by:

getReservationCoverage in interface AWSCostExplorer

Parameters:

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

Returns:

Result of the GetReservationCoverage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getReservationPurchaseRecommendation

public GetReservationPurchaseRecommendationResult getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest request)

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.

Specified by:

getReservationPurchaseRecommendation in interface AWSCostExplorer

Parameters:

getReservationPurchaseRecommendationRequest -

Returns:

Result of the GetReservationPurchaseRecommendation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getReservationUtilization

public GetReservationUtilizationResult getReservationUtilization(GetReservationUtilizationRequest request)

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.

Specified by:

getReservationUtilization in interface AWSCostExplorer

Parameters:

getReservationUtilizationRequest -

Returns:

Result of the GetReservationUtilization operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getRightsizingRecommendation

public GetRightsizingRecommendationResult getRightsizingRecommendation(GetRightsizingRecommendationRequest request)

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.

Specified by:

getRightsizingRecommendation in interface AWSCostExplorer

Parameters:

getRightsizingRecommendationRequest -

Returns:

Result of the GetRightsizingRecommendation operation returned by the service.

Throws:

LimitExceededException - You made too many calls in a short period of time. Try again later.

InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.

See Also:

AWS API Documentation

getTags

public GetTagsResult getTags(GetTagsRequest request)

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

Specified by:

getTags in interface AWSCostExplorer

Parameters:

getTagsRequest -

Returns:

Result of the GetTags operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getUsageForecast

public GetUsageForecastResult getUsageForecast(GetUsageForecastRequest request)

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.

Specified by:

getUsageForecast in interface AWSCostExplorer

Parameters:

getUsageForecastRequest -

Returns:

Result of the GetUsageForecast operation returned by the service.

Throws:

LimitExceededException - You made too many calls in a short period of time. Try again later.

DataUnavailableException - The requested data is unavailable.

UnresolvableUsageUnitException - Cost Explorer was unable to identify the usage unit. Provide UsageType/UsageTypeGroup filter selections that contain matching units, for example: hours.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSCostExplorer

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.