com.amazonaws.services.costexplorer

Interface AWSCostExplorer

All Known Subinterfaces:

AWSCostExplorerAsync

All Known Implementing Classes:

AbstractAWSCostExplorer, AbstractAWSCostExplorerAsync, AWSCostExplorerAsyncClient, AWSCostExplorerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCostExplorer

Interface for accessing AWS Cost Explorer.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCostExplorer instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateCostCategoryDefinitionResult	createCostCategoryDefinition(CreateCostCategoryDefinitionRequest createCostCategoryDefinitionRequest)
DeleteCostCategoryDefinitionResult	deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest deleteCostCategoryDefinitionRequest)
DescribeCostCategoryDefinitionResult	describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest describeCostCategoryDefinitionRequest)
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 getCostAndUsageRequest) Retrieves cost and usage metrics for your account.
GetCostAndUsageWithResourcesResult	getCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest getCostAndUsageWithResourcesRequest) Retrieves cost and usage metrics with resources for your account.
GetCostForecastResult	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.
GetDimensionValuesResult	getDimensionValues(GetDimensionValuesRequest getDimensionValuesRequest) Retrieves all available filter values for a specified filter over a period of time.
GetReservationCoverageResult	getReservationCoverage(GetReservationCoverageRequest getReservationCoverageRequest) Retrieves the reservation coverage for your account.
GetReservationPurchaseRecommendationResult	getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest getReservationPurchaseRecommendationRequest) Gets recommendations for which reservations to purchase.
GetReservationUtilizationResult	getReservationUtilization(GetReservationUtilizationRequest getReservationUtilizationRequest) Retrieves the reservation utilization for your account.
GetRightsizingRecommendationResult	getRightsizingRecommendation(GetRightsizingRecommendationRequest getRightsizingRecommendationRequest) Creates recommendations that helps you save cost by identifying idle and underutilized Amazon EC2 instances.
GetSavingsPlansCoverageResult	getSavingsPlansCoverage(GetSavingsPlansCoverageRequest getSavingsPlansCoverageRequest) Retrieves the Savings Plans covered for your account.
GetSavingsPlansPurchaseRecommendationResult	getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest getSavingsPlansPurchaseRecommendationRequest) Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
GetSavingsPlansUtilizationResult	getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest getSavingsPlansUtilizationRequest) Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.
GetSavingsPlansUtilizationDetailsResult	getSavingsPlansUtilizationDetails(GetSavingsPlansUtilizationDetailsRequest getSavingsPlansUtilizationDetailsRequest) Retrieves attribute data along with aggregate utilization and savings data for a given time period.
GetTagsResult	getTags(GetTagsRequest getTagsRequest) Queries for available tag keys and tag values for a specified period.
GetUsageForecastResult	getUsageForecast(GetUsageForecastRequest getUsageForecastRequest) 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.
ListCostCategoryDefinitionsResult	listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateCostCategoryDefinitionResult	updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest updateCostCategoryDefinitionRequest)

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createCostCategoryDefinition

CreateCostCategoryDefinitionResult createCostCategoryDefinition(CreateCostCategoryDefinitionRequest createCostCategoryDefinitionRequest)

Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).

Creates a new Cost Category with the requested name and rules.

Parameters:

createCostCategoryDefinitionRequest -

Returns:

Result of the CreateCostCategoryDefinition operation returned by the service.

Throws:

ServiceQuotaExceededException - You've reached the limit on the number of resources you can create, or exceeded the size of an individual resources.

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

See Also:

AWS API Documentation

deleteCostCategoryDefinition

DeleteCostCategoryDefinitionResult deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest deleteCostCategoryDefinitionRequest)

Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).

Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.

Parameters:

deleteCostCategoryDefinitionRequest -

Returns:

Result of the DeleteCostCategoryDefinition operation returned by the service.

Throws:

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

See Also:

AWS API Documentation

describeCostCategoryDefinition

DescribeCostCategoryDefinitionResult describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest describeCostCategoryDefinitionRequest)

Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).

Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.

You have the option to use EffectiveOn to return a Cost Category that is active on a specific date. If there is no EffectiveOn specified, you’ll see a Cost Category that is effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.

Parameters:

describeCostCategoryDefinitionRequest -

Returns:

Result of the DescribeCostCategoryDefinition operation returned by the service.

Throws:

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

See Also:

AWS API Documentation

getCostAndUsage

GetCostAndUsageResult 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:

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

getCostAndUsageWithResources

GetCostAndUsageWithResourcesResult getCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest getCostAndUsageWithResourcesRequest)

Retrieves cost and usage metrics with resources 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 API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.

Parameters:

getCostAndUsageWithResourcesRequest -

Returns:

Result of the GetCostAndUsageWithResources operation returned by the service.

Throws:

DataUnavailableException - The requested data is unavailable.

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.

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

GetCostForecastResult 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:

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

GetDimensionValuesResult 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:

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

GetReservationCoverageResult getReservationCoverage(GetReservationCoverageRequest getReservationCoverageRequest)

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.

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

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

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

GetReservationUtilizationResult 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:

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

GetRightsizingRecommendationResult getRightsizingRecommendation(GetRightsizingRecommendationRequest getRightsizingRecommendationRequest)

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.

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

getSavingsPlansCoverage

GetSavingsPlansCoverageResult getSavingsPlansCoverage(GetSavingsPlansCoverageRequest getSavingsPlansCoverageRequest)

Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s master account can see the coverage of the associated member accounts. For any time period, you can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

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

Parameters:

getSavingsPlansCoverageRequest -

Returns:

Result of the GetSavingsPlansCoverage 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

getSavingsPlansPurchaseRecommendation

GetSavingsPlansPurchaseRecommendationResult getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest getSavingsPlansPurchaseRecommendationRequest)

Retrieves your request parameters, Savings Plan Recommendations Summary and Details.

Parameters:

getSavingsPlansPurchaseRecommendationRequest -

Returns:

Result of the GetSavingsPlansPurchaseRecommendation 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

getSavingsPlansUtilization

GetSavingsPlansUtilizationResult getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest getSavingsPlansUtilizationRequest)

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Master accounts in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

You cannot group by any dimension values for GetSavingsPlansUtilization.

Parameters:

getSavingsPlansUtilizationRequest -

Returns:

Result of the GetSavingsPlansUtilization 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

getSavingsPlansUtilizationDetails

GetSavingsPlansUtilizationDetailsResult getSavingsPlansUtilizationDetails(GetSavingsPlansUtilizationDetailsRequest getSavingsPlansUtilizationDetailsRequest)

Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

Parameters:

getSavingsPlansUtilizationDetailsRequest -

Returns:

Result of the GetSavingsPlansUtilizationDetails 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

getTags

GetTagsResult 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:

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

GetUsageForecastResult getUsageForecast(GetUsageForecastRequest getUsageForecastRequest)

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.

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

listCostCategoryDefinitions

ListCostCategoryDefinitionsResult listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest)

Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).

Returns the name, ARN and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.

Parameters:

listCostCategoryDefinitionsRequest -

Returns:

Result of the ListCostCategoryDefinitions operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

updateCostCategoryDefinition

UpdateCostCategoryDefinitionResult updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest updateCostCategoryDefinitionRequest)

Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).

Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.

Parameters:

updateCostCategoryDefinitionRequest -

Returns:

Result of the UpdateCostCategoryDefinition operation returned by the service.

Throws:

ResourceNotFoundException - The specified ARN in the request doesn't exist.

ServiceQuotaExceededException - You've reached the limit on the number of resources you can create, or exceeded the size of an individual resources.

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

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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