@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCostExplorerClient extends AmazonWebServiceClient implements AWSCostExplorer
You can use the Cost Explorer API 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. This might include 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 the costs that are associated with the Cost Explorer API, see Amazon Web Services Cost Management Pricing.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSCostExplorerClientBuilder |
builder() |
CreateAnomalyMonitorResult |
createAnomalyMonitor(CreateAnomalyMonitorRequest request)
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
|
CreateAnomalySubscriptionResult |
createAnomalySubscription(CreateAnomalySubscriptionRequest request)
Adds an alert subscription to a cost anomaly detection monitor.
|
CreateCostCategoryDefinitionResult |
createCostCategoryDefinition(CreateCostCategoryDefinitionRequest request)
Creates a new Cost Category with the requested name and rules.
|
DeleteAnomalyMonitorResult |
deleteAnomalyMonitor(DeleteAnomalyMonitorRequest request)
Deletes a cost anomaly monitor.
|
DeleteAnomalySubscriptionResult |
deleteAnomalySubscription(DeleteAnomalySubscriptionRequest request)
Deletes a cost anomaly subscription.
|
DeleteCostCategoryDefinitionResult |
deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest request)
Deletes a Cost Category.
|
DescribeCostCategoryDefinitionResult |
describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest request)
Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's
defined in the account.
|
GetAnomaliesResult |
getAnomalies(GetAnomaliesRequest request)
Retrieves all of the cost anomalies detected on your account during the time period that's specified by the
DateInterval object. |
GetAnomalyMonitorsResult |
getAnomalyMonitors(GetAnomalyMonitorsRequest request)
Retrieves the cost anomaly monitor definitions for your account.
|
GetAnomalySubscriptionsResult |
getAnomalySubscriptions(GetAnomalySubscriptionsRequest request)
Retrieves the cost anomaly subscription objects for your account.
|
GetApproximateUsageRecordsResult |
getApproximateUsageRecords(GetApproximateUsageRecordsRequest request)
Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.
|
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.
|
GetCostAndUsageWithResourcesResult |
getCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest request)
Retrieves cost and usage metrics with resources for your account.
|
GetCostCategoriesResult |
getCostCategories(GetCostCategoriesRequest request)
Retrieves an array of Cost Category names and values incurred cost.
|
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, which you can use 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.
|
GetReservationPurchaseRecommendationResult |
getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest request)
Gets recommendations for reservation purchases.
|
GetReservationUtilizationResult |
getReservationUtilization(GetReservationUtilizationRequest request)
Retrieves the reservation utilization for your account.
|
GetRightsizingRecommendationResult |
getRightsizingRecommendation(GetRightsizingRecommendationRequest request)
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
|
GetSavingsPlanPurchaseRecommendationDetailsResult |
getSavingsPlanPurchaseRecommendationDetails(GetSavingsPlanPurchaseRecommendationDetailsRequest request)
Retrieves the details for a Savings Plan recommendation.
|
GetSavingsPlansCoverageResult |
getSavingsPlansCoverage(GetSavingsPlansCoverageRequest request)
Retrieves the Savings Plans covered for your account.
|
GetSavingsPlansPurchaseRecommendationResult |
getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest request)
Retrieves the Savings Plans recommendations for your account.
|
GetSavingsPlansUtilizationResult |
getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest request)
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.
|
GetSavingsPlansUtilizationDetailsResult |
getSavingsPlansUtilizationDetails(GetSavingsPlansUtilizationDetailsRequest request)
Retrieves attribute data along with aggregate utilization and savings data for a given time period.
|
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.
|
ListCostAllocationTagBackfillHistoryResult |
listCostAllocationTagBackfillHistory(ListCostAllocationTagBackfillHistoryRequest request)
Retrieves a list of your historical cost allocation tag backfill requests.
|
ListCostAllocationTagsResult |
listCostAllocationTags(ListCostAllocationTagsRequest request)
Get a list of cost allocation tags.
|
ListCostCategoryDefinitionsResult |
listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest request)
Returns the name, Amazon Resource Name (ARN),
NumberOfRules and effective dates of all Cost
Categories defined in the account. |
ListSavingsPlansPurchaseRecommendationGenerationResult |
listSavingsPlansPurchaseRecommendationGeneration(ListSavingsPlansPurchaseRecommendationGenerationRequest request)
Retrieves a list of your historical recommendation generations within the past 30 days.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
|
ProvideAnomalyFeedbackResult |
provideAnomalyFeedback(ProvideAnomalyFeedbackRequest request)
Modifies the feedback property of a given cost anomaly.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartCostAllocationTagBackfillResult |
startCostAllocationTagBackfill(StartCostAllocationTagBackfillRequest request)
Request a cost allocation tag backfill.
|
StartSavingsPlansPurchaseRecommendationGenerationResult |
startSavingsPlansPurchaseRecommendationGeneration(StartSavingsPlansPurchaseRecommendationGenerationRequest request)
Requests a Savings Plans recommendation generation.
|
TagResourceResult |
tagResource(TagResourceRequest request)
An API operation for adding one or more tags (key-value pairs) to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from a resource.
|
UpdateAnomalyMonitorResult |
updateAnomalyMonitor(UpdateAnomalyMonitorRequest request)
Updates an existing cost anomaly monitor.
|
UpdateAnomalySubscriptionResult |
updateAnomalySubscription(UpdateAnomalySubscriptionRequest request)
Updates an existing cost anomaly subscription.
|
UpdateCostAllocationTagsStatusResult |
updateCostAllocationTagsStatus(UpdateCostAllocationTagsStatusRequest request)
Updates status for cost allocation tags in bulk, with maximum batch size of 20.
|
UpdateCostCategoryDefinitionResult |
updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest request)
Updates an existing Cost Category.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSCostExplorerClientBuilder builder()
public CreateAnomalyMonitorResult createAnomalyMonitor(CreateAnomalyMonitorRequest request)
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
createAnomalyMonitor in interface AWSCostExplorercreateAnomalyMonitorRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.public CreateAnomalySubscriptionResult createAnomalySubscription(CreateAnomalySubscriptionRequest request)
Adds an alert subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set an absolute or percentage threshold and a time frequency for receiving notifications.
createAnomalySubscription in interface AWSCostExplorercreateAnomalySubscriptionRequest - UnknownMonitorException - The cost anomaly monitor does not exist for the account.LimitExceededException - You made too many calls in a short period of time. Try again later.public CreateCostCategoryDefinitionResult createCostCategoryDefinition(CreateCostCategoryDefinitionRequest request)
Creates a new Cost Category with the requested name and rules.
createCostCategoryDefinition in interface AWSCostExplorercreateCostCategoryDefinitionRequest - ServiceQuotaExceededException - You've reached the limit on the number of resources you can create, or exceeded the size of an individual
resource.LimitExceededException - You made too many calls in a short period of time. Try again later.public DeleteAnomalyMonitorResult deleteAnomalyMonitor(DeleteAnomalyMonitorRequest request)
Deletes a cost anomaly monitor.
deleteAnomalyMonitor in interface AWSCostExplorerdeleteAnomalyMonitorRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.UnknownMonitorException - The cost anomaly monitor does not exist for the account.public DeleteAnomalySubscriptionResult deleteAnomalySubscription(DeleteAnomalySubscriptionRequest request)
Deletes a cost anomaly subscription.
deleteAnomalySubscription in interface AWSCostExplorerdeleteAnomalySubscriptionRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.UnknownSubscriptionException - The cost anomaly subscription does not exist for the account.public DeleteCostCategoryDefinitionResult deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest request)
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
deleteCostCategoryDefinition in interface AWSCostExplorerdeleteCostCategoryDefinitionRequest - 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.public DescribeCostCategoryDefinitionResult describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest request)
Returns the name, Amazon Resource 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's active on a specific date.
If there's no EffectiveOn specified, you see a Cost Category that's effective on the current date.
If Cost Category is still effective, EffectiveEnd is omitted in the response.
describeCostCategoryDefinition in interface AWSCostExplorerdescribeCostCategoryDefinitionRequest - 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.public GetAnomaliesResult getAnomalies(GetAnomaliesRequest request)
Retrieves all of the cost anomalies detected on your account during the time period that's specified by the
DateInterval object. Anomalies are available for up to 90 days.
getAnomalies in interface AWSCostExplorergetAnomaliesRequest - 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.public GetAnomalyMonitorsResult getAnomalyMonitors(GetAnomalyMonitorsRequest request)
Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
getAnomalyMonitors in interface AWSCostExplorergetAnomalyMonitorsRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.UnknownMonitorException - The cost anomaly monitor does not exist for the account.InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.public GetAnomalySubscriptionsResult getAnomalySubscriptions(GetAnomalySubscriptionsRequest request)
Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
getAnomalySubscriptions in interface AWSCostExplorergetAnomalySubscriptionsRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.UnknownSubscriptionException - The cost anomaly subscription does not exist for the account.InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.public GetApproximateUsageRecordsResult getApproximateUsageRecords(GetApproximateUsageRecordsRequest request)
Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.
getApproximateUsageRecords in interface AWSCostExplorergetApproximateUsageRecordsRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.public GetCostAndUsageResult getCostAndUsage(GetCostAndUsageRequest request)
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you
want the request to return. For example, you can specify BlendedCosts or UsageQuantity.
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. Management account in an organization in Organizations have access to all
member accounts.
For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
getCostAndUsage in interface AWSCostExplorergetCostAndUsageRequest - 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.public GetCostAndUsageWithResourcesResult getCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest request)
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. Management account in an organization in Organizations have access to all
member accounts.
Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud) resource-level data. All other resource-level data is available at daily granularity.
This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information about how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.
getCostAndUsageWithResources in interface AWSCostExplorergetCostAndUsageWithResourcesRequest - 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.public GetCostCategoriesResult getCostCategories(GetCostCategoriesRequest request)
Retrieves an array of Cost Category names and values incurred cost.
If some Cost Category names and values are not associated with any cost, they will not be returned by this API.
getCostCategories in interface AWSCostExplorergetCostCategoriesRequest - 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.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.
getCostForecast in interface AWSCostExplorergetCostForecastRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.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.
getDimensionValues in interface AWSCostExplorergetDimensionValuesRequest - 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.public GetReservationCoverageResult getReservationCoverage(GetReservationCoverageRequest request)
Retrieves the reservation coverage for your account, which you can use 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 management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. 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.
getReservationCoverage in interface AWSCostExplorergetReservationCoverageRequest - You can use the following request parameters to query for how much of your instance usage a reservation
covered.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.public GetReservationPurchaseRecommendationResult getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest request)
Gets recommendations for reservation purchases. These recommendations might help you to reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
Amazon Web Services 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 Amazon Web Services has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of Reserved Instance (RI) to purchase to maximize your estimated savings.
For example, Amazon Web Services 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. Amazon Web Services recommends the smallest size instance in an instance family. This makes
it easier to purchase a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of
normalized units. This way, you can purchase any instance size that you want. For this example, your RI
recommendation is for c4.large because that is the smallest size instance in the c4 instance family.
getReservationPurchaseRecommendation in interface AWSCostExplorergetReservationPurchaseRecommendationRequest - 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.public GetReservationUtilizationResult getReservationUtilization(GetReservationUtilizationRequest request)
Retrieves the reservation utilization for your account. Management account 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.
getReservationUtilization in interface AWSCostExplorergetReservationUtilizationRequest - 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.public GetRightsizingRecommendationResult getRightsizingRecommendation(GetRightsizingRecommendationRequest request)
Creates recommendations that help 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 more information about calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide.
getRightsizingRecommendation in interface AWSCostExplorergetRightsizingRecommendationRequest - 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.public GetSavingsPlanPurchaseRecommendationDetailsResult getSavingsPlanPurchaseRecommendationDetails(GetSavingsPlanPurchaseRecommendationDetailsRequest request)
Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.
getSavingsPlanPurchaseRecommendationDetails in interface AWSCostExplorergetSavingsPlanPurchaseRecommendationDetailsRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.public GetSavingsPlansCoverageResult getSavingsPlansCoverage(GetSavingsPlansCoverageRequest request)
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 management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. 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.
getSavingsPlansCoverage in interface AWSCostExplorergetSavingsPlansCoverageRequest - 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.public GetSavingsPlansPurchaseRecommendationResult getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest request)
Retrieves the Savings Plans recommendations for your account. First use
StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations, and then
use GetSavingsPlansPurchaseRecommendation to retrieve them.
getSavingsPlansPurchaseRecommendation in interface AWSCostExplorergetSavingsPlansPurchaseRecommendationRequest - 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.public GetSavingsPlansUtilizationResult getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest request)
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.
Management account in an organization have access to member accounts. You can use GetDimensionValues
in SAVINGS_PLANS to determine the possible dimension values.
You can't group by any dimension values for GetSavingsPlansUtilization.
getSavingsPlansUtilization in interface AWSCostExplorergetSavingsPlansUtilizationRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.public GetSavingsPlansUtilizationDetailsResult getSavingsPlansUtilizationDetails(GetSavingsPlansUtilizationDetailsRequest request)
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.
getSavingsPlansUtilizationDetails in interface AWSCostExplorergetSavingsPlansUtilizationDetailsRequest - 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.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.
getTags in interface AWSCostExplorergetTagsRequest - 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.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.
getUsageForecast in interface AWSCostExplorergetUsageForecastRequest - 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.public ListCostAllocationTagBackfillHistoryResult listCostAllocationTagBackfillHistory(ListCostAllocationTagBackfillHistoryRequest request)
Retrieves a list of your historical cost allocation tag backfill requests.
listCostAllocationTagBackfillHistory in interface AWSCostExplorerlistCostAllocationTagBackfillHistoryRequest - 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.public ListCostAllocationTagsResult listCostAllocationTags(ListCostAllocationTagsRequest request)
Get a list of cost allocation tags. All inputs in the API are optional and serve as filters. By default, all cost allocation tags are returned.
listCostAllocationTags in interface AWSCostExplorerlistCostAllocationTagsRequest - 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.public ListCostCategoryDefinitionsResult listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest request)
Returns the name, Amazon Resource Name (ARN), NumberOfRules 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. ListCostCategoryDefinitions supports
pagination. The request can have a MaxResults range up to 100.
listCostCategoryDefinitions in interface AWSCostExplorerlistCostCategoryDefinitionsRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.public ListSavingsPlansPurchaseRecommendationGenerationResult listSavingsPlansPurchaseRecommendationGeneration(ListSavingsPlansPurchaseRecommendationGenerationRequest request)
Retrieves a list of your historical recommendation generations within the past 30 days.
listSavingsPlansPurchaseRecommendationGeneration in interface AWSCostExplorerlistSavingsPlansPurchaseRecommendationGenerationRequest - 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.DataUnavailableException - The requested data is unavailable.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
listTagsForResource in interface AWSCostExplorerlistTagsForResourceRequest - 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.public ProvideAnomalyFeedbackResult provideAnomalyFeedback(ProvideAnomalyFeedbackRequest request)
Modifies the feedback property of a given cost anomaly.
provideAnomalyFeedback in interface AWSCostExplorerprovideAnomalyFeedbackRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.public StartCostAllocationTagBackfillResult startCostAllocationTagBackfill(StartCostAllocationTagBackfillRequest request)
Request a cost allocation tag backfill. This will backfill the activation status (either active or
inactive) for all tag keys from para:BackfillFrom up to the when this request is made.
You can request a backfill once every 24 hours.
startCostAllocationTagBackfill in interface AWSCostExplorerstartCostAllocationTagBackfillRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.BackfillLimitExceededException - A request to backfill is already in progress. Once the previous request is complete, you can create
another request.public StartSavingsPlansPurchaseRecommendationGenerationResult startSavingsPlansPurchaseRecommendationGeneration(StartSavingsPlansPurchaseRecommendationGenerationRequest request)
Requests a Savings Plans recommendation generation. This enables you to calculate a fresh set of Savings Plans recommendations that takes your latest usage data and current Savings Plans inventory into account. You can refresh Savings Plans recommendations up to three times daily for a consolidated billing family.
StartSavingsPlansPurchaseRecommendationGeneration has no request syntax because no input parameters
are needed to support this operation.
startSavingsPlansPurchaseRecommendationGeneration in interface AWSCostExplorerstartSavingsPlansPurchaseRecommendationGenerationRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.ServiceQuotaExceededException - You've reached the limit on the number of resources you can create, or exceeded the size of an individual
resource.GenerationExistsException - A request to generate a recommendation is already in progress.DataUnavailableException - The requested data is unavailable.public TagResourceResult tagResource(TagResourceRequest request)
An API operation for adding one or more tags (key-value pairs) to a resource.
You can use the TagResource operation with a resource that already has tags. If you specify a new
tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a
tag key that is already associated with the resource, the new tag value you specify replaces the previous value
for that tag.
Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.
tagResource in interface AWSCostExplorertagResourceRequest - ResourceNotFoundException - The specified ARN in the request doesn't exist.TooManyTagsException - Can occur if you specify a number of tags for a resource greater than the maximum 50 user tags per
resource.LimitExceededException - You made too many calls in a short period of time. Try again later.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
untagResource in interface AWSCostExploreruntagResourceRequest - 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.public UpdateAnomalyMonitorResult updateAnomalyMonitor(UpdateAnomalyMonitorRequest request)
Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.
updateAnomalyMonitor in interface AWSCostExplorerupdateAnomalyMonitorRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.UnknownMonitorException - The cost anomaly monitor does not exist for the account.public UpdateAnomalySubscriptionResult updateAnomalySubscription(UpdateAnomalySubscriptionRequest request)
Updates an existing cost anomaly subscription. Specify the fields that you want to update. Omitted fields are unchanged.
The JSON below describes the generic construct for each type. See Request Parameters for possible values as they apply to AnomalySubscription.
updateAnomalySubscription in interface AWSCostExplorerupdateAnomalySubscriptionRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.UnknownMonitorException - The cost anomaly monitor does not exist for the account.UnknownSubscriptionException - The cost anomaly subscription does not exist for the account.public UpdateCostAllocationTagsStatusResult updateCostAllocationTagsStatus(UpdateCostAllocationTagsStatusRequest request)
Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag status that's updated is the same as the existing tag status, the request doesn't fail. Instead, it doesn't have any effect on the tag status (for example, activating the active tag).
updateCostAllocationTagsStatus in interface AWSCostExplorerupdateCostAllocationTagsStatusRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.public UpdateCostCategoryDefinitionResult updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest request)
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.
updateCostCategoryDefinition in interface AWSCostExplorerupdateCostCategoryDefinitionRequest - 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
resource.LimitExceededException - You made too many calls in a short period of time. Try again later.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AWSCostExplorerrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSCostExplorershutdown in class AmazonWebServiceClient