Amazon.CostExplorer.Model

An unusual cost pattern. This consists of the detailed metadata and the current status of the anomaly object.

The time period for an anomaly.

This object continuously inspects your account's cost data for anomalies. It's based on MonitorType and MonitorSpecification. The content consists of detailed metadata and the current status of the monitor object.

Quantifies the anomaly. The higher score means that it's more anomalous.

An AnomalySubscription resource (also referred to as an alert subscription) sends notifications about specific anomalies that meet an alerting criteria defined by you.

You can specify the frequency of the alerts and the subscribers to notify.

Anomaly subscriptions can be associated with one or more AnomalyMonitor resources, and they only send notifications about anomalies detected by those associated monitors. You can also configure a threshold to further control which anomalies are included in the notifications.

Anomalies that don’t exceed the chosen threshold and therefore don’t trigger notifications from an anomaly subscription will still be available on the console and from the GetAnomalies API.

A request to backfill is already in progress. Once the previous request is complete, you can create another request.

The requested report expired. Update the date interval and try again.

The cost allocation tag structure. This includes detailed metadata for the CostAllocationTag object.

The cost allocation tag backfill request structure that contains metadata and details of a certain backfill.

The cost allocation tag status. The status of a key can either be active or inactive.

The structure of Cost Categories. This includes detailed metadata and the set of rules for the CostCategory object.

When you create or update a cost category, you can define the CostCategoryRule rule type as INHERITED_VALUE. This rule type adds the flexibility to define a rule that dynamically inherits the cost category value from the dimension value that's defined by CostCategoryInheritedValueDimension. For example, suppose that you want to dynamically group costs that are based on the value of a specific tag key. First, choose an inherited value rule type, and then choose the tag dimension and specify the tag key to use.

The list of processing statuses for Cost Management products for a specific cost category.

A reference to a Cost Category containing only enough information to identify the Cost Category.

You can use this information to retrieve the full Cost Category information using DescribeCostCategory.

Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.

Use the split charge rule to split the cost of one Cost Category value across several other target values.

The parameters for a split charge method.

The Cost Categories values used for filtering the costs.

If Values and Key are not specified, the ABSENT MatchOption is applied to all Cost Categories. That is, it filters on resources that aren't mapped to any Cost Categories.

If Values is provided and Key isn't specified, the ABSENT MatchOption is applied to the Cost Categories Key only. That is, it filters on resources without the given Cost Categories key.

Paginators for the CostExplorer service

The amount of instance usage that a reservation covered.

Reservation coverage for a specified period, in hours.

How much it costs to run an instance.

How long a running instance either used a reservation or was On-Demand.

The amount of instance usage, in normalized units. You can use normalized units to see your EC2 usage for multiple sizes of instances in a uniform way. For example, suppose that you run an xlarge instance and a 2xlarge instance. If you run both instances for the same amount of time, the 2xlarge instance uses twice as much of your reservation as the xlarge instance, even though both instances show only one instance-hour. When you use normalized units instead of instance-hours, the xlarge instance used 8 normalized units, and the 2xlarge instance used 16 normalized units.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

Container for the parameters to the CreateAnomalyMonitor operation. Creates a new cost anomaly detection monitor with the requested type and monitor specification.

This is the response object from the CreateAnomalyMonitor operation.

Container for the parameters to the CreateAnomalySubscription operation. 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.

This is the response object from the CreateAnomalySubscription operation.

Container for the parameters to the CreateCostCategoryDefinition operation. Creates a new Cost Category with the requested name and rules.

This is the response object from the CreateCostCategoryDefinition operation.

Context about the current instance.

The requested data is unavailable.

The time period of the request.

Container for the parameters to the DeleteAnomalyMonitor operation. Deletes a cost anomaly monitor.

This is the response object from the DeleteAnomalyMonitor operation.

Container for the parameters to the DeleteAnomalySubscription operation. Deletes a cost anomaly subscription.

This is the response object from the DeleteAnomalySubscription operation.

Container for the parameters to the DeleteCostCategoryDefinition operation. Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.

This is the response object from the DeleteCostCategoryDefinition operation.

Container for the parameters to the DescribeCostCategoryDefinition operation. 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.

This is the response object from the DescribeCostCategoryDefinition operation.

The metadata that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

The metadata of a specific type that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

The field that contains a list of disk (local storage) metrics that are associated with the current instance.

The EBS field that contains a list of EBS metrics that are associated with the current instance.

Details about the Amazon EC2 reservations that Amazon Web Services recommends that you purchase.

Details on the Amazon EC2 Resource.

Utilization metrics for the instance.

The Amazon EC2 hardware specifications that you want Amazon Web Services to provide recommendations for.

Details about the Amazon ElastiCache reservations that Amazon Web Services recommends that you purchase.

Details about the Amazon OpenSearch Service reservations that Amazon Web Services recommends that you purchase.

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

• Simple dimension values.

  • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

    • Specify the CostCategories field to define a filter that acts on Cost Categories.

    • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

    • Specify the Dimensions field to define a filter that acts on the DimensionValues .

  • For each filter type, you can set the dimension name and values for the filters that you plan to use.

    • For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).

    • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }

    • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

  • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

    • For example, you can filter for linked account names that start with "a".

    • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }

• Compound Expression types with logical operations.

  • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

  • For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).

  • The corresponding Expression for this example is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

The forecast that's created for your query.

A request to generate a recommendation is already in progress.

The summary of the Savings Plans recommendation generation.

Container for the parameters to the GetAnomalies operation. 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.

This is the response object from the GetAnomalies operation.

Container for the parameters to the GetAnomalyMonitors operation. Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).

This is the response object from the GetAnomalyMonitors operation.

Container for the parameters to the GetAnomalySubscriptions operation. Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).

This is the response object from the GetAnomalySubscriptions operation.

Container for the parameters to the GetApproximateUsageRecords operation. Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.

This is the response object from the GetApproximateUsageRecords operation.

Container for the parameters to the GetCostAndUsage operation. 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.

This is the response object from the GetCostAndUsage operation.

Container for the parameters to the GetCostAndUsageWithResources operation. 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. 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 about how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.

This is the response object from the GetCostAndUsageWithResources operation.

Container for the parameters to the GetCostCategories operation. 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.

This is the response object from the GetCostCategories operation.

Container for the parameters to the GetCostForecast operation. 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.

This is the response object from the GetCostForecast operation.

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

This is the response object from the GetDimensionValues operation.

Container for the parameters to the GetReservationCoverage operation. 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.

This is the response object from the GetReservationCoverage operation.

Container for the parameters to the GetReservationPurchaseRecommendation operation. 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.

This is the response object from the GetReservationPurchaseRecommendation operation.

Container for the parameters to the GetReservationUtilization operation. 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.

This is the response object from the GetReservationUtilization operation.

Container for the parameters to the GetRightsizingRecommendation operation. 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.

This is the response object from the GetRightsizingRecommendation operation.

Container for the parameters to the GetSavingsPlanPurchaseRecommendationDetails operation. Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.

This is the response object from the GetSavingsPlanPurchaseRecommendationDetails operation.

Container for the parameters to the GetSavingsPlansCoverage operation. 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.

This is the response object from the GetSavingsPlansCoverage operation.

Container for the parameters to the GetSavingsPlansPurchaseRecommendation operation. 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.

This is the response object from the GetSavingsPlansPurchaseRecommendation operation.

Container for the parameters to the GetSavingsPlansUtilizationDetails operation. 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.

This is the response object from the GetSavingsPlansUtilizationDetails operation.

Container for the parameters to the GetSavingsPlansUtilization operation. 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.

This is the response object from the GetSavingsPlansUtilization operation.

Container for the parameters to the GetTags operation. Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.

This is the response object from the GetTags operation.

Container for the parameters to the GetUsageForecast operation. 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.

This is the response object from the GetUsageForecast operation.

One level of grouped data in the results.

Represents a group when you specify a group by criteria or in the response to a query with a specific grouping.

The dollar value of the anomaly.

Details about the reservations that Amazon Web Services recommends that you purchase.

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

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

Container for the parameters to the ListCostAllocationTagBackfillHistory operation. Retrieves a list of your historical cost allocation tag backfill requests.

This is the response object from the ListCostAllocationTagBackfillHistory operation.

Container for the parameters to the ListCostAllocationTags operation. 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.

This is the response object from the ListCostAllocationTags operation.

Container for the parameters to the ListCostCategoryDefinitions operation. 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.

This is the response object from the ListCostCategoryDefinitions operation.

Container for the parameters to the ListSavingsPlansPurchaseRecommendationGeneration operation. Retrieves a list of your historical recommendation generations within the past 30 days.

This is the response object from the ListSavingsPlansPurchaseRecommendationGeneration operation.

Container for the parameters to the ListTagsForResource operation. Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).

This is the response object from the ListTagsForResource operation.

Details about the MemoryDB reservations that Amazon Web Services recommends that you purchase.

The aggregated value for a metric.

Details for the modification recommendation.

The network field that contains a list of network metrics that are associated with the current instance.

Container for the parameters to the ProvideAnomalyFeedback operation. Modifies the feedback property of a given cost anomaly.

This is the response object from the ProvideAnomalyFeedback operation.

Details about the Amazon RDS reservations that Amazon Web Services recommends that you purchase.

The details and metrics for the given recommendation.

Contains the hourly metrics for the given recommendation over the lookback period.

Details about the Amazon Redshift reservations that Amazon Web Services recommends that you purchase.

Your request parameters changed between pages. Try again with the old parameters or without a pagination token.

The aggregated numbers for your reservation usage.

A group of reservations that share a set of attributes.

A specific reservation that Amazon Web Services recommends for purchase.

Details about your recommended reservation purchase.

Information about this specific recommendation, such as the timestamp for when Amazon Web Services made a specific recommendation.

A summary about this recommendation, such as the currency code, the amount that Amazon Web Services estimates that you could save, and the total amount of reservation to purchase.

A group of reservations that share a set of attributes.

Details for the resource.

The specified ARN in the request doesn't exist.

The tag structure that contains a tag key and value.

Tagging is supported only for the following Cost Explorer resource types: AnomalyMonitor , AnomalySubscription , CostCategory .

Resource utilization of current resource.

The result that's associated with a time period.

Recommendations to rightsize resources.

You can use RightsizingRecommendationConfiguration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or Reserved Instance (RI) benefits, or neither.

Metadata for this recommendation set.

The summary of rightsizing recommendations

The combination of Amazon Web Service, linked account, linked account name, Region, and usage type where a cost anomaly is observed. The linked account name will only be available when the account name can be identified.

The amortized amount of Savings Plans purchased in a specific account during a specific time interval.

The amount of Savings Plans eligible usage that's covered by Savings Plans. All calculations consider the On-Demand equivalent of your Savings Plans usage.

Specific coverage percentage, On-Demand costs, and spend covered by Savings Plans, and total Savings Plans costs for an account.

The attribute details on a specific Savings Plan.

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

Details for your recommended Savings Plans.

Metadata about your Savings Plans Purchase Recommendations.

Summary metrics for your Savings Plans Purchase Recommendations.

The amount of savings that you're accumulating, against the public On-Demand rate of the usage accrued in an account.

The measurement of how well you're using your existing Savings Plans.

The aggregated utilization metrics for your Savings Plans usage.

The amount of Savings Plans utilization (in hours).

A single daily or monthly Savings Plans utilization rate and details for your account. A management account in an organization have access to member accounts. You can use GetDimensionValues to determine the possible dimension values.

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

Hardware specifications for the service that you want recommendations for.

The details for how to sort the data.

Container for the parameters to the StartCostAllocationTagBackfill operation. 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.

This is the response object from the StartCostAllocationTagBackfill operation.

Container for the parameters to the StartSavingsPlansPurchaseRecommendationGeneration operation. 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.

This is the response object from the StartSavingsPlansPurchaseRecommendationGeneration operation.

The recipient of AnomalySubscription notifications.

Container for the parameters to the TagResource operation. 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.

This is the response object from the TagResource operation.

The values that are available for a tag.

If Values and Key aren't specified, the ABSENT MatchOption is applied to all tags. That is, it's filtered on resources with no tags.

If Key is provided and Values isn't specified, the ABSENT MatchOption is applied to the tag Key only. That is, it's filtered on resources without the given tag key.

Details on recommended instance.

Details on termination recommendation.

Can occur if you specify a number of tags for a resource greater than the maximum 50 user tags per resource.

Filters cost anomalies based on the total impact.

The cost anomaly monitor does not exist for the account.

The cost anomaly subscription does not exist for the account.

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

Container for the parameters to the UntagResource operation. Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.

This is the response object from the UntagResource operation.

Container for the parameters to the UpdateAnomalyMonitor operation. Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.

This is the response object from the UpdateAnomalyMonitor operation.

Container for the parameters to the UpdateAnomalySubscription operation. 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.

This is the response object from the UpdateAnomalySubscription operation.

Gives a detailed description of the result of an action. It's on each cost allocation tag entry in the request.

Container for the parameters to the UpdateCostAllocationTagsStatus operation. 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).

This is the response object from the UpdateCostAllocationTagsStatus operation.

Container for the parameters to the UpdateCostCategoryDefinition operation. 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.

This is the response object from the UpdateCostCategoryDefinition operation.

The amount of utilization, in hours.

Paginators for the CostExplorer service

Paginator for the GetSavingsPlansCoverage operation

Paginator for the GetSavingsPlansUtilizationDetails operation

Paginator for the ListCostAllocationTagBackfillHistory operation

Paginator for the ListCostAllocationTags operation

Paginator for the ListCostCategoryDefinitions operation