@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCostExplorer
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCostExplorer instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateAnomalyMonitorResult |
createAnomalyMonitor(CreateAnomalyMonitorRequest createAnomalyMonitorRequest)
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
|
CreateAnomalySubscriptionResult |
createAnomalySubscription(CreateAnomalySubscriptionRequest createAnomalySubscriptionRequest)
Adds an alert subscription to a cost anomaly detection monitor.
|
CreateCostCategoryDefinitionResult |
createCostCategoryDefinition(CreateCostCategoryDefinitionRequest createCostCategoryDefinitionRequest)
Creates a new Cost Category with the requested name and rules.
|
DeleteAnomalyMonitorResult |
deleteAnomalyMonitor(DeleteAnomalyMonitorRequest deleteAnomalyMonitorRequest)
Deletes a cost anomaly monitor.
|
DeleteAnomalySubscriptionResult |
deleteAnomalySubscription(DeleteAnomalySubscriptionRequest deleteAnomalySubscriptionRequest)
Deletes a cost anomaly subscription.
|
DeleteCostCategoryDefinitionResult |
deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest deleteCostCategoryDefinitionRequest)
Deletes a Cost Category.
|
DescribeCostCategoryDefinitionResult |
describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest describeCostCategoryDefinitionRequest)
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 getAnomaliesRequest)
Retrieves all of the cost anomalies detected on your account during the time period that's specified by the
DateInterval object. |
GetAnomalyMonitorsResult |
getAnomalyMonitors(GetAnomalyMonitorsRequest getAnomalyMonitorsRequest)
Retrieves the cost anomaly monitor definitions for your account.
|
GetAnomalySubscriptionsResult |
getAnomalySubscriptions(GetAnomalySubscriptionsRequest getAnomalySubscriptionsRequest)
Retrieves the cost anomaly subscription objects for your account.
|
GetApproximateUsageRecordsResult |
getApproximateUsageRecords(GetApproximateUsageRecordsRequest getApproximateUsageRecordsRequest)
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 getCostAndUsageRequest)
Retrieves cost and usage metrics for your account.
|
GetCostAndUsageWithResourcesResult |
getCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest getCostAndUsageWithResourcesRequest)
Retrieves cost and usage metrics with resources for your account.
|
GetCostCategoriesResult |
getCostCategories(GetCostCategoriesRequest getCostCategoriesRequest)
Retrieves an array of Cost Category names and values incurred cost.
|
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, 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 getReservationPurchaseRecommendationRequest)
Gets recommendations for reservation purchases.
|
GetReservationUtilizationResult |
getReservationUtilization(GetReservationUtilizationRequest getReservationUtilizationRequest)
Retrieves the reservation utilization for your account.
|
GetRightsizingRecommendationResult |
getRightsizingRecommendation(GetRightsizingRecommendationRequest getRightsizingRecommendationRequest)
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
|
GetSavingsPlanPurchaseRecommendationDetailsResult |
getSavingsPlanPurchaseRecommendationDetails(GetSavingsPlanPurchaseRecommendationDetailsRequest getSavingsPlanPurchaseRecommendationDetailsRequest)
Retrieves the details for a Savings Plan recommendation.
|
GetSavingsPlansCoverageResult |
getSavingsPlansCoverage(GetSavingsPlansCoverageRequest getSavingsPlansCoverageRequest)
Retrieves the Savings Plans covered for your account.
|
GetSavingsPlansPurchaseRecommendationResult |
getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest getSavingsPlansPurchaseRecommendationRequest)
Retrieves the Savings Plans recommendations for your account.
|
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.
|
ListCostAllocationTagBackfillHistoryResult |
listCostAllocationTagBackfillHistory(ListCostAllocationTagBackfillHistoryRequest listCostAllocationTagBackfillHistoryRequest)
Retrieves a list of your historical cost allocation tag backfill requests.
|
ListCostAllocationTagsResult |
listCostAllocationTags(ListCostAllocationTagsRequest listCostAllocationTagsRequest)
Get a list of cost allocation tags.
|
ListCostCategoryDefinitionsResult |
listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest)
Returns the name, Amazon Resource Name (ARN),
NumberOfRules and effective dates of all Cost
Categories defined in the account. |
ListSavingsPlansPurchaseRecommendationGenerationResult |
listSavingsPlansPurchaseRecommendationGeneration(ListSavingsPlansPurchaseRecommendationGenerationRequest listSavingsPlansPurchaseRecommendationGenerationRequest)
Retrieves a list of your historical recommendation generations within the past 30 days.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
|
ProvideAnomalyFeedbackResult |
provideAnomalyFeedback(ProvideAnomalyFeedbackRequest provideAnomalyFeedbackRequest)
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 startCostAllocationTagBackfillRequest)
Request a cost allocation tag backfill.
|
StartSavingsPlansPurchaseRecommendationGenerationResult |
startSavingsPlansPurchaseRecommendationGeneration(StartSavingsPlansPurchaseRecommendationGenerationRequest startSavingsPlansPurchaseRecommendationGenerationRequest)
Requests a Savings Plans recommendation generation.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
An API operation for adding one or more tags (key-value pairs) to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a resource.
|
UpdateAnomalyMonitorResult |
updateAnomalyMonitor(UpdateAnomalyMonitorRequest updateAnomalyMonitorRequest)
Updates an existing cost anomaly monitor.
|
UpdateAnomalySubscriptionResult |
updateAnomalySubscription(UpdateAnomalySubscriptionRequest updateAnomalySubscriptionRequest)
Updates an existing cost anomaly subscription.
|
UpdateCostAllocationTagsStatusResult |
updateCostAllocationTagsStatus(UpdateCostAllocationTagsStatusRequest updateCostAllocationTagsStatusRequest)
Updates status for cost allocation tags in bulk, with maximum batch size of 20.
|
UpdateCostCategoryDefinitionResult |
updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest updateCostCategoryDefinitionRequest)
Updates an existing Cost Category.
|
static final String ENDPOINT_PREFIX
CreateAnomalyMonitorResult createAnomalyMonitor(CreateAnomalyMonitorRequest createAnomalyMonitorRequest)
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
createAnomalyMonitorRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.CreateAnomalySubscriptionResult createAnomalySubscription(CreateAnomalySubscriptionRequest createAnomalySubscriptionRequest)
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.
createAnomalySubscriptionRequest - 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.CreateCostCategoryDefinitionResult createCostCategoryDefinition(CreateCostCategoryDefinitionRequest createCostCategoryDefinitionRequest)
Creates a new Cost Category with the requested name and rules.
createCostCategoryDefinitionRequest - 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.DeleteAnomalyMonitorResult deleteAnomalyMonitor(DeleteAnomalyMonitorRequest deleteAnomalyMonitorRequest)
Deletes a cost anomaly monitor.
deleteAnomalyMonitorRequest - 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.DeleteAnomalySubscriptionResult deleteAnomalySubscription(DeleteAnomalySubscriptionRequest deleteAnomalySubscriptionRequest)
Deletes a cost anomaly subscription.
deleteAnomalySubscriptionRequest - 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.DeleteCostCategoryDefinitionResult deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest deleteCostCategoryDefinitionRequest)
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
deleteCostCategoryDefinitionRequest - 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.DescribeCostCategoryDefinitionResult describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest describeCostCategoryDefinitionRequest)
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.
describeCostCategoryDefinitionRequest - 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.GetAnomaliesResult getAnomalies(GetAnomaliesRequest getAnomaliesRequest)
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.
getAnomaliesRequest - 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.GetAnomalyMonitorsResult getAnomalyMonitors(GetAnomalyMonitorsRequest getAnomalyMonitorsRequest)
Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
getAnomalyMonitorsRequest - 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.GetAnomalySubscriptionsResult getAnomalySubscriptions(GetAnomalySubscriptionsRequest getAnomalySubscriptionsRequest)
Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
getAnomalySubscriptionsRequest - 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.GetApproximateUsageRecordsResult getApproximateUsageRecords(GetApproximateUsageRecordsRequest getApproximateUsageRecordsRequest)
Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.
getApproximateUsageRecordsRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.GetCostAndUsageResult getCostAndUsage(GetCostAndUsageRequest getCostAndUsageRequest)
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.
getCostAndUsageRequest - 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.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. 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.
getCostAndUsageWithResourcesRequest - 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.GetCostCategoriesResult getCostCategories(GetCostCategoriesRequest getCostCategoriesRequest)
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.
getCostCategoriesRequest - 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.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.
getCostForecastRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.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.
getDimensionValuesRequest - 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.GetReservationCoverageResult getReservationCoverage(GetReservationCoverageRequest getReservationCoverageRequest)
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.
getReservationCoverageRequest - 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.GetReservationPurchaseRecommendationResult getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest getReservationPurchaseRecommendationRequest)
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.
getReservationPurchaseRecommendationRequest - 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.GetReservationUtilizationResult getReservationUtilization(GetReservationUtilizationRequest getReservationUtilizationRequest)
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.
getReservationUtilizationRequest - 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.GetRightsizingRecommendationResult getRightsizingRecommendation(GetRightsizingRecommendationRequest getRightsizingRecommendationRequest)
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.
getRightsizingRecommendationRequest - 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.GetSavingsPlanPurchaseRecommendationDetailsResult getSavingsPlanPurchaseRecommendationDetails(GetSavingsPlanPurchaseRecommendationDetailsRequest getSavingsPlanPurchaseRecommendationDetailsRequest)
Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.
getSavingsPlanPurchaseRecommendationDetailsRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.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 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.
getSavingsPlansCoverageRequest - 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.GetSavingsPlansPurchaseRecommendationResult getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest getSavingsPlansPurchaseRecommendationRequest)
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.
getSavingsPlansPurchaseRecommendationRequest - 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.GetSavingsPlansUtilizationResult getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest getSavingsPlansUtilizationRequest)
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.
getSavingsPlansUtilizationRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.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.
getSavingsPlansUtilizationDetailsRequest - 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.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.
getTagsRequest - 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.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.
getUsageForecastRequest - 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.ListCostAllocationTagBackfillHistoryResult listCostAllocationTagBackfillHistory(ListCostAllocationTagBackfillHistoryRequest listCostAllocationTagBackfillHistoryRequest)
Retrieves a list of your historical cost allocation tag backfill requests.
listCostAllocationTagBackfillHistoryRequest - 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.ListCostAllocationTagsResult listCostAllocationTags(ListCostAllocationTagsRequest listCostAllocationTagsRequest)
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.
listCostAllocationTagsRequest - 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.ListCostCategoryDefinitionsResult listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest)
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.
listCostCategoryDefinitionsRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.ListSavingsPlansPurchaseRecommendationGenerationResult listSavingsPlansPurchaseRecommendationGeneration(ListSavingsPlansPurchaseRecommendationGenerationRequest listSavingsPlansPurchaseRecommendationGenerationRequest)
Retrieves a list of your historical recommendation generations within the past 30 days.
listSavingsPlansPurchaseRecommendationGenerationRequest - 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
listTagsForResourceRequest - 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.ProvideAnomalyFeedbackResult provideAnomalyFeedback(ProvideAnomalyFeedbackRequest provideAnomalyFeedbackRequest)
Modifies the feedback property of a given cost anomaly.
provideAnomalyFeedbackRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.StartCostAllocationTagBackfillResult startCostAllocationTagBackfill(StartCostAllocationTagBackfillRequest startCostAllocationTagBackfillRequest)
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.
startCostAllocationTagBackfillRequest - 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.StartSavingsPlansPurchaseRecommendationGenerationResult startSavingsPlansPurchaseRecommendationGeneration(StartSavingsPlansPurchaseRecommendationGenerationRequest startSavingsPlansPurchaseRecommendationGenerationRequest)
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.
startSavingsPlansPurchaseRecommendationGenerationRequest - 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
untagResourceRequest - 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.UpdateAnomalyMonitorResult updateAnomalyMonitor(UpdateAnomalyMonitorRequest updateAnomalyMonitorRequest)
Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.
updateAnomalyMonitorRequest - 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.UpdateAnomalySubscriptionResult updateAnomalySubscription(UpdateAnomalySubscriptionRequest updateAnomalySubscriptionRequest)
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.
updateAnomalySubscriptionRequest - 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.UpdateCostAllocationTagsStatusResult updateCostAllocationTagsStatus(UpdateCostAllocationTagsStatusRequest updateCostAllocationTagsStatusRequest)
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).
updateCostAllocationTagsStatusRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.UpdateCostCategoryDefinitionResult updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest updateCostCategoryDefinitionRequest)
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.
updateCostCategoryDefinitionRequest - 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.void shutdown()
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 a request.
request - The originally executed request.