{ "version":"2.0", "metadata":{ "apiVersion":"2017-10-25", "endpointPrefix":"ce", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"AWS Cost Explorer", "serviceFullName":"AWS Cost Explorer Service", "serviceId":"Cost Explorer", "signatureVersion":"v4", "signingName":"ce", "targetPrefix":"AWSInsightsIndexService", "uid":"ce-2017-10-25" }, "operations":{ "CreateAnomalyMonitor":{ "name":"CreateAnomalyMonitor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAnomalyMonitorRequest"}, "output":{"shape":"CreateAnomalyMonitorResponse"}, "errors":[ {"shape":"LimitExceededException"} ], "documentation":"

Creates a new cost anomaly detection monitor with the requested type and monitor specification.

" }, "CreateAnomalySubscription":{ "name":"CreateAnomalySubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAnomalySubscriptionRequest"}, "output":{"shape":"CreateAnomalySubscriptionResponse"}, "errors":[ {"shape":"UnknownMonitorException"}, {"shape":"LimitExceededException"} ], "documentation":"

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.

" }, "CreateCostCategoryDefinition":{ "name":"CreateCostCategoryDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCostCategoryDefinitionRequest"}, "output":{"shape":"CreateCostCategoryDefinitionResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"LimitExceededException"} ], "documentation":"

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

" }, "DeleteAnomalyMonitor":{ "name":"DeleteAnomalyMonitor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAnomalyMonitorRequest"}, "output":{"shape":"DeleteAnomalyMonitorResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"UnknownMonitorException"} ], "documentation":"

Deletes a cost anomaly monitor.

" }, "DeleteAnomalySubscription":{ "name":"DeleteAnomalySubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAnomalySubscriptionRequest"}, "output":{"shape":"DeleteAnomalySubscriptionResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"UnknownSubscriptionException"} ], "documentation":"

Deletes a cost anomaly subscription.

" }, "DeleteCostCategoryDefinition":{ "name":"DeleteCostCategoryDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCostCategoryDefinitionRequest"}, "output":{"shape":"DeleteCostCategoryDefinitionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

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

" }, "DescribeCostCategoryDefinition":{ "name":"DescribeCostCategoryDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCostCategoryDefinitionRequest"}, "output":{"shape":"DescribeCostCategoryDefinitionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

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.

" }, "GetAnomalies":{ "name":"GetAnomalies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAnomaliesRequest"}, "output":{"shape":"GetAnomaliesResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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.

" }, "GetAnomalyMonitors":{ "name":"GetAnomalyMonitors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAnomalyMonitorsRequest"}, "output":{"shape":"GetAnomalyMonitorsResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"UnknownMonitorException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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

" }, "GetAnomalySubscriptions":{ "name":"GetAnomalySubscriptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAnomalySubscriptionsRequest"}, "output":{"shape":"GetAnomalySubscriptionsResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"UnknownSubscriptionException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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

" }, "GetCostAndUsage":{ "name":"GetCostAndUsage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCostAndUsageRequest"}, "output":{"shape":"GetCostAndUsageResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"BillExpirationException"}, {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"}, {"shape":"RequestChangedException"} ], "documentation":"

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.

" }, "GetCostAndUsageWithResources":{ "name":"GetCostAndUsageWithResources", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCostAndUsageWithResourcesRequest"}, "output":{"shape":"GetCostAndUsageWithResourcesResponse"}, "errors":[ {"shape":"DataUnavailableException"}, {"shape":"LimitExceededException"}, {"shape":"BillExpirationException"}, {"shape":"InvalidNextTokenException"}, {"shape":"RequestChangedException"} ], "documentation":"

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.

" }, "GetCostCategories":{ "name":"GetCostCategories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCostCategoriesRequest"}, "output":{"shape":"GetCostCategoriesResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"BillExpirationException"}, {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"}, {"shape":"RequestChangedException"} ], "documentation":"

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.

" }, "GetCostForecast":{ "name":"GetCostForecast", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCostForecastRequest"}, "output":{"shape":"GetCostForecastResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"} ], "documentation":"

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.

" }, "GetDimensionValues":{ "name":"GetDimensionValues", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDimensionValuesRequest"}, "output":{"shape":"GetDimensionValuesResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"BillExpirationException"}, {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"}, {"shape":"RequestChangedException"} ], "documentation":"

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

" }, "GetReservationCoverage":{ "name":"GetReservationCoverage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetReservationCoverageRequest"}, "output":{"shape":"GetReservationCoverageResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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.

" }, "GetReservationPurchaseRecommendation":{ "name":"GetReservationPurchaseRecommendation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetReservationPurchaseRecommendationRequest"}, "output":{"shape":"GetReservationPurchaseRecommendationResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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.

" }, "GetReservationUtilization":{ "name":"GetReservationUtilization", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetReservationUtilizationRequest"}, "output":{"shape":"GetReservationUtilizationResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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

" }, "GetRightsizingRecommendation":{ "name":"GetRightsizingRecommendation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRightsizingRecommendationRequest"}, "output":{"shape":"GetRightsizingRecommendationResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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.

" }, "GetSavingsPlanPurchaseRecommendationDetails":{ "name":"GetSavingsPlanPurchaseRecommendationDetails", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSavingsPlanPurchaseRecommendationDetailsRequest"}, "output":{"shape":"GetSavingsPlanPurchaseRecommendationDetailsResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"} ], "documentation":"

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

" }, "GetSavingsPlansCoverage":{ "name":"GetSavingsPlansCoverage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSavingsPlansCoverageRequest"}, "output":{"shape":"GetSavingsPlansCoverageResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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.

" }, "GetSavingsPlansPurchaseRecommendation":{ "name":"GetSavingsPlansPurchaseRecommendation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSavingsPlansPurchaseRecommendationRequest"}, "output":{"shape":"GetSavingsPlansPurchaseRecommendationResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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.

" }, "GetSavingsPlansUtilization":{ "name":"GetSavingsPlansUtilization", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSavingsPlansUtilizationRequest"}, "output":{"shape":"GetSavingsPlansUtilizationResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"} ], "documentation":"

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

" }, "GetSavingsPlansUtilizationDetails":{ "name":"GetSavingsPlansUtilizationDetails", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSavingsPlansUtilizationDetailsRequest"}, "output":{"shape":"GetSavingsPlansUtilizationDetailsResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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

" }, "GetTags":{ "name":"GetTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTagsRequest"}, "output":{"shape":"GetTagsResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"BillExpirationException"}, {"shape":"DataUnavailableException"}, {"shape":"InvalidNextTokenException"}, {"shape":"RequestChangedException"} ], "documentation":"

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

" }, "GetUsageForecast":{ "name":"GetUsageForecast", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetUsageForecastRequest"}, "output":{"shape":"GetUsageForecastResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"DataUnavailableException"}, {"shape":"UnresolvableUsageUnitException"} ], "documentation":"

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.

" }, "ListCostAllocationTags":{ "name":"ListCostAllocationTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCostAllocationTagsRequest"}, "output":{"shape":"ListCostAllocationTagsResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

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.

" }, "ListCostCategoryDefinitions":{ "name":"ListCostCategoryDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCostCategoryDefinitionsRequest"}, "output":{"shape":"ListCostCategoryDefinitionsResponse"}, "errors":[ {"shape":"LimitExceededException"} ], "documentation":"

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.

" }, "ListSavingsPlansPurchaseRecommendationGeneration":{ "name":"ListSavingsPlansPurchaseRecommendationGeneration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSavingsPlansPurchaseRecommendationGenerationRequest"}, "output":{"shape":"ListSavingsPlansPurchaseRecommendationGenerationResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"InvalidNextTokenException"}, {"shape":"DataUnavailableException"} ], "documentation":"

Retrieves a list of your historical recommendation generations within the past 30 days.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).

" }, "ProvideAnomalyFeedback":{ "name":"ProvideAnomalyFeedback", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ProvideAnomalyFeedbackRequest"}, "output":{"shape":"ProvideAnomalyFeedbackResponse"}, "errors":[ {"shape":"LimitExceededException"} ], "documentation":"

Modifies the feedback property of a given cost anomaly.

" }, "StartSavingsPlansPurchaseRecommendationGeneration":{ "name":"StartSavingsPlansPurchaseRecommendationGeneration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartSavingsPlansPurchaseRecommendationGenerationRequest"}, "output":{"shape":"StartSavingsPlansPurchaseRecommendationGenerationResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"GenerationExistsException"}, {"shape":"DataUnavailableException"} ], "documentation":"

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.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"TooManyTagsException"}, {"shape":"LimitExceededException"} ], "documentation":"

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.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.

" }, "UpdateAnomalyMonitor":{ "name":"UpdateAnomalyMonitor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAnomalyMonitorRequest"}, "output":{"shape":"UpdateAnomalyMonitorResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"UnknownMonitorException"} ], "documentation":"

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

" }, "UpdateAnomalySubscription":{ "name":"UpdateAnomalySubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAnomalySubscriptionRequest"}, "output":{"shape":"UpdateAnomalySubscriptionResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"UnknownMonitorException"}, {"shape":"UnknownSubscriptionException"} ], "documentation":"

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

" }, "UpdateCostAllocationTagsStatus":{ "name":"UpdateCostAllocationTagsStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateCostAllocationTagsStatusRequest"}, "output":{"shape":"UpdateCostAllocationTagsStatusResponse"}, "errors":[ {"shape":"LimitExceededException"} ], "documentation":"

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

" }, "UpdateCostCategoryDefinition":{ "name":"UpdateCostCategoryDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateCostCategoryDefinitionRequest"}, "output":{"shape":"UpdateCostCategoryDefinitionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"LimitExceededException"} ], "documentation":"

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.

" } }, "shapes":{ "AccountScope":{ "type":"string", "enum":[ "PAYER", "LINKED" ] }, "AmortizedRecurringFee":{"type":"string"}, "AmortizedUpfrontFee":{"type":"string"}, "Anomalies":{ "type":"list", "member":{"shape":"Anomaly"} }, "Anomaly":{ "type":"structure", "required":[ "AnomalyId", "AnomalyScore", "Impact", "MonitorArn" ], "members":{ "AnomalyId":{ "shape":"GenericString", "documentation":"

The unique identifier for the anomaly.

" }, "AnomalyStartDate":{ "shape":"YearMonthDay", "documentation":"

The first day the anomaly is detected.

" }, "AnomalyEndDate":{ "shape":"YearMonthDay", "documentation":"

The last day the anomaly is detected.

" }, "DimensionValue":{ "shape":"GenericString", "documentation":"

The dimension for the anomaly (for example, an Amazon Web Service in a service monitor).

" }, "RootCauses":{ "shape":"RootCauses", "documentation":"

The list of identified root causes for the anomaly.

" }, "AnomalyScore":{ "shape":"AnomalyScore", "documentation":"

The latest and maximum score for the anomaly.

" }, "Impact":{ "shape":"Impact", "documentation":"

The dollar impact for the anomaly.

" }, "MonitorArn":{ "shape":"GenericString", "documentation":"

The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.

" }, "Feedback":{ "shape":"AnomalyFeedbackType", "documentation":"

The feedback value.

" } }, "documentation":"

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

" }, "AnomalyDateInterval":{ "type":"structure", "required":["StartDate"], "members":{ "StartDate":{ "shape":"YearMonthDay", "documentation":"

The first date an anomaly was observed.

" }, "EndDate":{ "shape":"YearMonthDay", "documentation":"

The last date an anomaly was observed.

" } }, "documentation":"

The time period for an anomaly.

" }, "AnomalyFeedbackType":{ "type":"string", "enum":[ "YES", "NO", "PLANNED_ACTIVITY" ] }, "AnomalyMonitor":{ "type":"structure", "required":[ "MonitorName", "MonitorType" ], "members":{ "MonitorArn":{ "shape":"GenericString", "documentation":"

The Amazon Resource Name (ARN) value.

" }, "MonitorName":{ "shape":"GenericString", "documentation":"

The name of the monitor.

" }, "CreationDate":{ "shape":"YearMonthDay", "documentation":"

The date when the monitor was created.

" }, "LastUpdatedDate":{ "shape":"YearMonthDay", "documentation":"

The date when the monitor was last updated.

" }, "LastEvaluatedDate":{ "shape":"YearMonthDay", "documentation":"

The date when the monitor last evaluated for anomalies.

" }, "MonitorType":{ "shape":"MonitorType", "documentation":"

The possible type values.

" }, "MonitorDimension":{ "shape":"MonitorDimension", "documentation":"

The dimensions to evaluate.

" }, "MonitorSpecification":{"shape":"Expression"}, "DimensionalValueCount":{ "shape":"NonNegativeInteger", "documentation":"

The value for evaluated dimensions.

" } }, "documentation":"

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.

" }, "AnomalyMonitors":{ "type":"list", "member":{"shape":"AnomalyMonitor"} }, "AnomalyScore":{ "type":"structure", "required":[ "MaxScore", "CurrentScore" ], "members":{ "MaxScore":{ "shape":"GenericDouble", "documentation":"

The maximum score that's observed during the `AnomalyDateInterval`.

" }, "CurrentScore":{ "shape":"GenericDouble", "documentation":"

The last observed score.

" } }, "documentation":"

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

" }, "AnomalySubscription":{ "type":"structure", "required":[ "MonitorArnList", "Subscribers", "Frequency", "SubscriptionName" ], "members":{ "SubscriptionArn":{ "shape":"GenericString", "documentation":"

The `AnomalySubscription` Amazon Resource Name (ARN).

" }, "AccountId":{ "shape":"GenericString", "documentation":"

Your unique account identifier.

" }, "MonitorArnList":{ "shape":"MonitorArnList", "documentation":"

A list of cost anomaly monitors.

" }, "Subscribers":{ "shape":"Subscribers", "documentation":"

A list of subscribers to notify.

" }, "Threshold":{ "shape":"NullableNonNegativeDouble", "documentation":"

(deprecated)

An absolute dollar value that must be exceeded by the anomaly's total impact (see Impact for more details) for an anomaly notification to be generated.

This field has been deprecated. To specify a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.

One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.

", "deprecated":true, "deprecatedMessage":"Threshold has been deprecated in favor of ThresholdExpression" }, "Frequency":{ "shape":"AnomalySubscriptionFrequency", "documentation":"

The frequency that anomaly notifications are sent. Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see Creating an Amazon SNS topic for anomaly notifications.

" }, "SubscriptionName":{ "shape":"GenericString", "documentation":"

The name for the subscription.

" }, "ThresholdExpression":{ "shape":"Expression", "documentation":"

An Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are `ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE`, corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are `AND` and `OR`. The match option `GREATER_THAN_OR_EQUAL` is required. Values must be numbers between 0 and 10,000,000,000 in string format.

One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.

The following are examples of valid ThresholdExpressions:

- Absolute threshold: `{ \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }`

- Percentage threshold: `{ \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }`

- `AND` two thresholds together: `{ \"And\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }`

- `OR` two thresholds together: `{ \"Or\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }`

" } }, "documentation":"

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.

" }, "AnomalySubscriptionFrequency":{ "type":"string", "enum":[ "DAILY", "IMMEDIATE", "WEEKLY" ] }, "AnomalySubscriptions":{ "type":"list", "member":{"shape":"AnomalySubscription"} }, "Arn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+" }, "AttributeType":{"type":"string"}, "AttributeValue":{"type":"string"}, "Attributes":{ "type":"map", "key":{"shape":"AttributeType"}, "value":{"shape":"AttributeValue"} }, "BillExpirationException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

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

", "exception":true }, "Context":{ "type":"string", "enum":[ "COST_AND_USAGE", "RESERVATIONS", "SAVINGS_PLANS" ] }, "CostAllocationTag":{ "type":"structure", "required":[ "TagKey", "Type", "Status" ], "members":{ "TagKey":{ "shape":"TagKey", "documentation":"

The key for the cost allocation tag.

" }, "Type":{ "shape":"CostAllocationTagType", "documentation":"

The type of cost allocation tag. You can use `AWSGenerated` or `UserDefined` type tags. `AWSGenerated` type tags are tags that Amazon Web Services defines and applies to support Amazon Web Services resources for cost allocation purposes. `UserDefined` type tags are tags that you define, create, and apply to resources.

" }, "Status":{ "shape":"CostAllocationTagStatus", "documentation":"

The status of a cost allocation tag.

" }, "LastUpdatedDate":{ "shape":"ZonedDateTime", "documentation":"

The last date that the tag was either activated or deactivated.

" }, "LastUsedDate":{ "shape":"ZonedDateTime", "documentation":"

The last month that the tag was used on an Amazon Web Services resource.

" } }, "documentation":"

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

" }, "CostAllocationTagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":100, "min":1 }, "CostAllocationTagList":{ "type":"list", "member":{"shape":"CostAllocationTag"}, "max":100, "min":0 }, "CostAllocationTagStatus":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "CostAllocationTagStatusEntry":{ "type":"structure", "required":[ "TagKey", "Status" ], "members":{ "TagKey":{ "shape":"TagKey", "documentation":"

The key for the cost allocation tag.

" }, "Status":{ "shape":"CostAllocationTagStatus", "documentation":"

The status of a cost allocation tag.

" } }, "documentation":"

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

" }, "CostAllocationTagStatusList":{ "type":"list", "member":{"shape":"CostAllocationTagStatusEntry"}, "max":20, "min":1 }, "CostAllocationTagType":{ "type":"string", "enum":[ "AWSGenerated", "UserDefined" ] }, "CostAllocationTagsMaxResults":{ "type":"integer", "max":1000, "min":1 }, "CostCategory":{ "type":"structure", "required":[ "CostCategoryArn", "EffectiveStart", "Name", "RuleVersion", "Rules" ], "members":{ "CostCategoryArn":{ "shape":"Arn", "documentation":"

The unique identifier for your Cost Category.

" }, "EffectiveStart":{ "shape":"ZonedDateTime", "documentation":"

The effective start date of your Cost Category.

" }, "EffectiveEnd":{ "shape":"ZonedDateTime", "documentation":"

The effective end date of your Cost Category.

" }, "Name":{"shape":"CostCategoryName"}, "RuleVersion":{"shape":"CostCategoryRuleVersion"}, "Rules":{ "shape":"CostCategoryRulesList", "documentation":"

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

" }, "SplitChargeRules":{ "shape":"CostCategorySplitChargeRulesList", "documentation":"

The split charge rules that are used to allocate your charges between your Cost Category values.

" }, "ProcessingStatus":{ "shape":"CostCategoryProcessingStatusList", "documentation":"

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

" }, "DefaultValue":{"shape":"CostCategoryValue"} }, "documentation":"

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

" }, "CostCategoryInheritedValueDimension":{ "type":"structure", "members":{ "DimensionName":{ "shape":"CostCategoryInheritedValueDimensionName", "documentation":"

The name of the dimension that's used to group costs.

If you specify `LINKED_ACCOUNT_NAME`, the cost category value is based on account name. If you specify `TAG`, the cost category value is based on the value of the specified tag key.

" }, "DimensionKey":{ "shape":"GenericString", "documentation":"

The key to extract cost category values.

" } }, "documentation":"

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.

" }, "CostCategoryInheritedValueDimensionName":{ "type":"string", "enum":[ "LINKED_ACCOUNT_NAME", "TAG" ] }, "CostCategoryMaxResults":{ "type":"integer", "max":100, "min":1 }, "CostCategoryName":{ "type":"string", "documentation":"

The unique name of the Cost Category.

", "max":50, "min":1, "pattern":"^(?! )[\\p{L}\\p{N}\\p{Z}-_]*(?The Cost Management product name of the applied status. " }, "Status":{ "shape":"CostCategoryStatus", "documentation":"

The process status for a specific cost category.

" } }, "documentation":"

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

" }, "CostCategoryProcessingStatusList":{ "type":"list", "member":{"shape":"CostCategoryProcessingStatus"} }, "CostCategoryReference":{ "type":"structure", "members":{ "CostCategoryArn":{ "shape":"Arn", "documentation":"

The unique identifier for your Cost Category.

" }, "Name":{"shape":"CostCategoryName"}, "EffectiveStart":{ "shape":"ZonedDateTime", "documentation":"

The Cost Category's effective start date.

" }, "EffectiveEnd":{ "shape":"ZonedDateTime", "documentation":"

The Cost Category's effective end date.

" }, "NumberOfRules":{ "shape":"NonNegativeInteger", "documentation":"

The number of rules that are associated with a specific Cost Category.

" }, "ProcessingStatus":{ "shape":"CostCategoryProcessingStatusList", "documentation":"

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

" }, "Values":{ "shape":"CostCategoryValuesList", "documentation":"

A list of unique cost category values in a specific cost category.

" }, "DefaultValue":{"shape":"CostCategoryValue"} }, "documentation":"

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

" }, "CostCategoryReferencesList":{ "type":"list", "member":{"shape":"CostCategoryReference"} }, "CostCategoryRule":{ "type":"structure", "members":{ "Value":{"shape":"CostCategoryValue"}, "Rule":{ "shape":"Expression", "documentation":"

An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are `LINKED_ACCOUNT`, `SERVICE_CODE`, `RECORD_TYPE`, `LINKED_ACCOUNT_NAME`, `REGION`, and `USAGE_TYPE`.

`RECORD_TYPE` is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide.

" }, "InheritedValue":{ "shape":"CostCategoryInheritedValueDimension", "documentation":"

The value the line item is categorized as if the line item contains the matched dimension.

" }, "Type":{ "shape":"CostCategoryRuleType", "documentation":"

You can define the `CostCategoryRule` rule type as either `REGULAR` or `INHERITED_VALUE`. The `INHERITED_VALUE` rule type adds the flexibility to define a rule that dynamically inherits the cost category value. This value is from the dimension value that's defined by `CostCategoryInheritedValueDimension`. For example, suppose that you want to costs to be dynamically grouped 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.

" } }, "documentation":"

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.

" }, "CostCategoryRuleType":{ "type":"string", "enum":[ "REGULAR", "INHERITED_VALUE" ] }, "CostCategoryRuleVersion":{ "type":"string", "documentation":"

The rule schema version in this particular Cost Category.

", "enum":["CostCategoryExpression.v1"] }, "CostCategoryRulesList":{ "type":"list", "member":{"shape":"CostCategoryRule"}, "max":500, "min":1 }, "CostCategorySplitChargeMethod":{ "type":"string", "enum":[ "FIXED", "PROPORTIONAL", "EVEN" ] }, "CostCategorySplitChargeRule":{ "type":"structure", "required":[ "Source", "Targets", "Method" ], "members":{ "Source":{ "shape":"GenericString", "documentation":"

The Cost Category value that you want to split. That value can't be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.

" }, "Targets":{ "shape":"CostCategorySplitChargeRuleTargetsList", "documentation":"

The Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.

" }, "Method":{ "shape":"CostCategorySplitChargeMethod", "documentation":"

The method that's used to define how to split your source costs across your targets.

`Proportional` - Allocates charges across your targets based on the proportional weighted cost of each target.

`Fixed` - Allocates charges across your targets based on your defined allocation percentage.

>`Even` - Allocates costs evenly across all targets.

" }, "Parameters":{ "shape":"CostCategorySplitChargeRuleParametersList", "documentation":"

The parameters for a split charge method. This is only required for the `FIXED` method.

" } }, "documentation":"

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

" }, "CostCategorySplitChargeRuleParameter":{ "type":"structure", "required":[ "Type", "Values" ], "members":{ "Type":{ "shape":"CostCategorySplitChargeRuleParameterType", "documentation":"

The parameter type.

" }, "Values":{ "shape":"CostCategorySplitChargeRuleParameterValuesList", "documentation":"

The parameter values.

" } }, "documentation":"

The parameters for a split charge method.

" }, "CostCategorySplitChargeRuleParameterType":{ "type":"string", "enum":["ALLOCATION_PERCENTAGES"] }, "CostCategorySplitChargeRuleParameterValuesList":{ "type":"list", "member":{"shape":"GenericString"}, "max":500, "min":1 }, "CostCategorySplitChargeRuleParametersList":{ "type":"list", "member":{"shape":"CostCategorySplitChargeRuleParameter"}, "max":10, "min":1 }, "CostCategorySplitChargeRuleTargetsList":{ "type":"list", "member":{"shape":"GenericString"}, "max":500, "min":1 }, "CostCategorySplitChargeRulesList":{ "type":"list", "member":{"shape":"CostCategorySplitChargeRule"}, "max":10, "min":1 }, "CostCategoryStatus":{ "type":"string", "enum":[ "PROCESSING", "APPLIED" ] }, "CostCategoryStatusComponent":{ "type":"string", "enum":["COST_EXPLORER"] }, "CostCategoryValue":{ "type":"string", "documentation":"

The default value for the cost category.

", "max":50, "min":1, "pattern":"^(?! )[\\p{L}\\p{N}\\p{Z}-_]*(?The specific value of the Cost Category." }, "MatchOptions":{ "shape":"MatchOptions", "documentation":"

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for `MatchOptions` is `EQUALS` and `CASE_SENSITIVE`.

" } }, "documentation":"

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.

" }, "CostCategoryValuesList":{ "type":"list", "member":{"shape":"CostCategoryValue"} }, "Coverage":{ "type":"structure", "members":{ "CoverageHours":{ "shape":"CoverageHours", "documentation":"

The amount of instance usage that the reservation covered, in hours.

" }, "CoverageNormalizedUnits":{ "shape":"CoverageNormalizedUnits", "documentation":"

The amount of instance usage that the reservation covered, in normalized units.

" }, "CoverageCost":{ "shape":"CoverageCost", "documentation":"

The amount of cost that the reservation covered.

" } }, "documentation":"

The amount of instance usage that a reservation covered.

" }, "CoverageByTime":{ "type":"structure", "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

The period that this coverage was used over.

" }, "Groups":{ "shape":"ReservationCoverageGroups", "documentation":"

The groups of instances that the reservation covered.

" }, "Total":{ "shape":"Coverage", "documentation":"

The total reservation coverage, in hours.

" } }, "documentation":"

Reservation coverage for a specified period, in hours.

" }, "CoverageCost":{ "type":"structure", "members":{ "OnDemandCost":{ "shape":"OnDemandCost", "documentation":"

How much an On-Demand Instance costs.

" } }, "documentation":"

How much it costs to run an instance.

" }, "CoverageHours":{ "type":"structure", "members":{ "OnDemandHours":{ "shape":"OnDemandHours", "documentation":"

The number of instance running hours that On-Demand Instances covered.

" }, "ReservedHours":{ "shape":"ReservedHours", "documentation":"

The number of instance running hours that reservations covered.

" }, "TotalRunningHours":{ "shape":"TotalRunningHours", "documentation":"

The total instance usage, in hours.

" }, "CoverageHoursPercentage":{ "shape":"CoverageHoursPercentage", "documentation":"

The percentage of instance hours that a reservation covered.

" } }, "documentation":"

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

" }, "CoverageHoursPercentage":{"type":"string"}, "CoverageNormalizedUnits":{ "type":"structure", "members":{ "OnDemandNormalizedUnits":{ "shape":"OnDemandNormalizedUnits", "documentation":"

The number of normalized units that are covered by On-Demand Instances instead of a reservation.

" }, "ReservedNormalizedUnits":{ "shape":"ReservedNormalizedUnits", "documentation":"

The number of normalized units that a reservation covers.

" }, "TotalRunningNormalizedUnits":{ "shape":"TotalRunningNormalizedUnits", "documentation":"

The total number of normalized units that you used.

" }, "CoverageNormalizedUnitsPercentage":{ "shape":"CoverageNormalizedUnitsPercentage", "documentation":"

The percentage of your used instance normalized units that a reservation covers.

" } }, "documentation":"

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.

" }, "CoverageNormalizedUnitsPercentage":{"type":"string"}, "CoveragesByTime":{ "type":"list", "member":{"shape":"CoverageByTime"} }, "CreateAnomalyMonitorRequest":{ "type":"structure", "required":["AnomalyMonitor"], "members":{ "AnomalyMonitor":{ "shape":"AnomalyMonitor", "documentation":"

The cost anomaly detection monitor object that you want to create.

" }, "ResourceTags":{ "shape":"ResourceTagList", "documentation":"

An optional list of tags to associate with the specified `AnomalyMonitor` . You can use resource tags to control access to your `monitor` using IAM policies.

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

- Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

- The maximum length of a key is 128 characters

- The maximum length of a value is 256 characters

- Keys and values can only contain alphanumeric characters, spaces, and any of the following: `_.:/=+@-`

- Keys and values are case sensitive

- Keys and values are trimmed for any leading or trailing whitespaces

- Don’t use `aws:` as a prefix for your keys. This prefix is reserved for Amazon Web Services use

" } } }, "CreateAnomalyMonitorResponse":{ "type":"structure", "required":["MonitorArn"], "members":{ "MonitorArn":{ "shape":"GenericString", "documentation":"

The unique identifier of your newly created cost anomaly detection monitor.

" } } }, "CreateAnomalySubscriptionRequest":{ "type":"structure", "required":["AnomalySubscription"], "members":{ "AnomalySubscription":{ "shape":"AnomalySubscription", "documentation":"

The cost anomaly subscription object that you want to create.

" }, "ResourceTags":{ "shape":"ResourceTagList", "documentation":"

An optional list of tags to associate with the specified `AnomalySubscription` . You can use resource tags to control access to your `subscription` using IAM policies.

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

- Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

- The maximum length of a key is 128 characters

- The maximum length of a value is 256 characters

- Keys and values can only contain alphanumeric characters, spaces, and any of the following: `_.:/=+@-`

- Keys and values are case sensitive

- Keys and values are trimmed for any leading or trailing whitespaces

- Don’t use `aws:` as a prefix for your keys. This prefix is reserved for Amazon Web Services use

" } } }, "CreateAnomalySubscriptionResponse":{ "type":"structure", "required":["SubscriptionArn"], "members":{ "SubscriptionArn":{ "shape":"GenericString", "documentation":"

The unique identifier of your newly created cost anomaly subscription.

" } } }, "CreateCostCategoryDefinitionRequest":{ "type":"structure", "required":[ "Name", "RuleVersion", "Rules" ], "members":{ "Name":{"shape":"CostCategoryName"}, "EffectiveStart":{ "shape":"ZonedDateTime", "documentation":"

The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.

" }, "RuleVersion":{"shape":"CostCategoryRuleVersion"}, "Rules":{ "shape":"CostCategoryRulesList", "documentation":"

The Cost Category rules used to categorize costs. For more information, see CostCategoryRule.

" }, "DefaultValue":{"shape":"CostCategoryValue"}, "SplitChargeRules":{ "shape":"CostCategorySplitChargeRulesList", "documentation":"

The split charge rules used to allocate your charges between your Cost Category values.

" }, "ResourceTags":{ "shape":"ResourceTagList", "documentation":"

An optional list of tags to associate with the specified `CostCategory` . You can use resource tags to control access to your `cost category` using IAM policies.

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

- Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

- The maximum length of a key is 128 characters

- The maximum length of a value is 256 characters

- Keys and values can only contain alphanumeric characters, spaces, and any of the following: `_.:/=+@-`

- Keys and values are case sensitive

- Keys and values are trimmed for any leading or trailing whitespaces

- Don’t use `aws:` as a prefix for your keys. This prefix is reserved for Amazon Web Services use

" } } }, "CreateCostCategoryDefinitionResponse":{ "type":"structure", "members":{ "CostCategoryArn":{ "shape":"Arn", "documentation":"

The unique identifier for your newly created Cost Category.

" }, "EffectiveStart":{ "shape":"ZonedDateTime", "documentation":"

The Cost Category's effective start date. It can only be a billing start date (first day of the month).

" } } }, "CurrentInstance":{ "type":"structure", "members":{ "ResourceId":{ "shape":"GenericString", "documentation":"

Resource ID of the current instance.

" }, "InstanceName":{ "shape":"GenericString", "documentation":"

The name that you given an instance. This field shows as blank if you haven't given the instance a name.

" }, "Tags":{ "shape":"TagValuesList", "documentation":"

Cost allocation resource tags that are applied to the instance.

" }, "ResourceDetails":{ "shape":"ResourceDetails", "documentation":"

Details about the resource and utilization.

" }, "ResourceUtilization":{ "shape":"ResourceUtilization", "documentation":"

Utilization information of the current instance during the lookback period.

" }, "ReservationCoveredHoursInLookbackPeriod":{ "shape":"GenericString", "documentation":"

The number of hours during the lookback period that's covered by reservations.

" }, "SavingsPlansCoveredHoursInLookbackPeriod":{ "shape":"GenericString", "documentation":"

The number of hours during the lookback period that's covered by Savings Plans.

" }, "OnDemandHoursInLookbackPeriod":{ "shape":"GenericString", "documentation":"

The number of hours during the lookback period that's billed at On-Demand rates.

" }, "TotalRunningHoursInLookbackPeriod":{ "shape":"GenericString", "documentation":"

The total number of hours that the instance ran during the lookback period.

" }, "MonthlyCost":{ "shape":"GenericString", "documentation":"

The current On-Demand cost of operating this instance on a monthly basis.

" }, "CurrencyCode":{ "shape":"GenericString", "documentation":"

The currency code that Amazon Web Services used to calculate the costs for this instance.

" } }, "documentation":"

Context about the current instance.

" }, "DataUnavailableException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The requested data is unavailable.

", "exception":true }, "DateInterval":{ "type":"structure", "required":[ "Start", "End" ], "members":{ "Start":{ "shape":"YearMonthDay", "documentation":"

The beginning of the time period. The start date is inclusive. For example, if `start` is `2017-01-01`, Amazon Web Services retrieves cost and usage data starting at `2017-01-01` up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

" }, "End":{ "shape":"YearMonthDay", "documentation":"

The end of the time period. The end date is exclusive. For example, if `end` is `2017-05-01`, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, `2017-05-01`.

" } }, "documentation":"

The time period of the request.

" }, "DeleteAnomalyMonitorRequest":{ "type":"structure", "required":["MonitorArn"], "members":{ "MonitorArn":{ "shape":"GenericString", "documentation":"

The unique identifier of the cost anomaly monitor that you want to delete.

" } } }, "DeleteAnomalyMonitorResponse":{ "type":"structure", "members":{ } }, "DeleteAnomalySubscriptionRequest":{ "type":"structure", "required":["SubscriptionArn"], "members":{ "SubscriptionArn":{ "shape":"GenericString", "documentation":"

The unique identifier of the cost anomaly subscription that you want to delete.

" } } }, "DeleteAnomalySubscriptionResponse":{ "type":"structure", "members":{ } }, "DeleteCostCategoryDefinitionRequest":{ "type":"structure", "required":["CostCategoryArn"], "members":{ "CostCategoryArn":{ "shape":"Arn", "documentation":"

The unique identifier for your Cost Category.

" } } }, "DeleteCostCategoryDefinitionResponse":{ "type":"structure", "members":{ "CostCategoryArn":{ "shape":"Arn", "documentation":"

The unique identifier for your Cost Category.

" }, "EffectiveEnd":{ "shape":"ZonedDateTime", "documentation":"

The effective end date of the Cost Category as a result of deleting it. No costs after this date is categorized by the deleted Cost Category.

" } } }, "DescribeCostCategoryDefinitionRequest":{ "type":"structure", "required":["CostCategoryArn"], "members":{ "CostCategoryArn":{ "shape":"Arn", "documentation":"

The unique identifier for your Cost Category.

" }, "EffectiveOn":{ "shape":"ZonedDateTime", "documentation":"

The date when the Cost Category was effective.

" } } }, "DescribeCostCategoryDefinitionResponse":{ "type":"structure", "members":{ "CostCategory":{"shape":"CostCategory"} } }, "Dimension":{ "type":"string", "enum":[ "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "LINKED_ACCOUNT_NAME", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "SERVICE_CODE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "OPERATING_SYSTEM", "TENANCY", "SCOPE", "PLATFORM", "SUBSCRIPTION_ID", "LEGAL_ENTITY_NAME", "DEPLOYMENT_OPTION", "DATABASE_ENGINE", "CACHE_ENGINE", "INSTANCE_TYPE_FAMILY", "BILLING_ENTITY", "RESERVATION_ID", "RESOURCE_ID", "RIGHTSIZING_TYPE", "SAVINGS_PLANS_TYPE", "SAVINGS_PLAN_ARN", "PAYMENT_OPTION", "AGREEMENT_END_DATE_TIME_AFTER", "AGREEMENT_END_DATE_TIME_BEFORE", "INVOICING_ENTITY", "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "ANOMALY_TOTAL_IMPACT_PERCENTAGE" ] }, "DimensionValues":{ "type":"structure", "members":{ "Key":{ "shape":"Dimension", "documentation":"

The names of the metadata types that you can use to filter and group your results. For example, `AZ` returns a list of Availability Zones.

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

`LINK_ACCOUNT_NAME` and `SERVICE_CODE` can only be used in CostCategoryRule.

`ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE` can only be used in AnomalySubscriptions.

" }, "Values":{ "shape":"Values", "documentation":"

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

" }, "MatchOptions":{ "shape":"MatchOptions", "documentation":"

The match options that you can use to filter your results.

`MatchOptions` is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

The default values for `MatchOptions` are `EQUALS` and `CASE_SENSITIVE`.

" } }, "documentation":"

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

" }, "DimensionValuesWithAttributes":{ "type":"structure", "members":{ "Value":{ "shape":"Value", "documentation":"

The value of a dimension with a specific attribute.

" }, "Attributes":{ "shape":"Attributes", "documentation":"

The attribute that applies to a specific `Dimension`.

" } }, "documentation":"

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

" }, "DimensionValuesWithAttributesList":{ "type":"list", "member":{"shape":"DimensionValuesWithAttributes"} }, "DiskResourceUtilization":{ "type":"structure", "members":{ "DiskReadOpsPerSecond":{ "shape":"GenericString", "documentation":"

The maximum number of read operations per second.

" }, "DiskWriteOpsPerSecond":{ "shape":"GenericString", "documentation":"

The maximum number of write operations per second.

" }, "DiskReadBytesPerSecond":{ "shape":"GenericString", "documentation":"

The maximum read throughput operations per second.

" }, "DiskWriteBytesPerSecond":{ "shape":"GenericString", "documentation":"

The maximum write throughput operations per second.

" } }, "documentation":"

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

" }, "EBSResourceUtilization":{ "type":"structure", "members":{ "EbsReadOpsPerSecond":{ "shape":"GenericString", "documentation":"

The maximum number of read operations per second.

" }, "EbsWriteOpsPerSecond":{ "shape":"GenericString", "documentation":"

The maximum number of write operations per second.

" }, "EbsReadBytesPerSecond":{ "shape":"GenericString", "documentation":"

The maximum size of read operations per second

" }, "EbsWriteBytesPerSecond":{ "shape":"GenericString", "documentation":"

The maximum size of write operations per second.

" } }, "documentation":"

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

" }, "EC2InstanceDetails":{ "type":"structure", "members":{ "Family":{ "shape":"GenericString", "documentation":"

The instance family of the recommended reservation.

" }, "InstanceType":{ "shape":"GenericString", "documentation":"

The type of instance that Amazon Web Services recommends.

" }, "Region":{ "shape":"GenericString", "documentation":"

The Amazon Web Services Region of the recommended reservation.

" }, "AvailabilityZone":{ "shape":"GenericString", "documentation":"

The Availability Zone of the recommended reservation.

" }, "Platform":{ "shape":"GenericString", "documentation":"

The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.

" }, "Tenancy":{ "shape":"GenericString", "documentation":"

Determines whether the recommended reservation is dedicated or shared.

" }, "CurrentGeneration":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommendation is for a current-generation instance.

" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommended reservation is size flexible.

" } }, "documentation":"

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

" }, "EC2ResourceDetails":{ "type":"structure", "members":{ "HourlyOnDemandRate":{ "shape":"GenericString", "documentation":"

The hourly public On-Demand rate for the instance type.

" }, "InstanceType":{ "shape":"GenericString", "documentation":"

The type of Amazon Web Services instance.

" }, "Platform":{ "shape":"GenericString", "documentation":"

The platform of the Amazon Web Services instance. The platform is the specific combination of operating system, license model, and software on an instance.

" }, "Region":{ "shape":"GenericString", "documentation":"

The Amazon Web Services Region of the instance.

" }, "Sku":{ "shape":"GenericString", "documentation":"

The SKU of the product.

" }, "Memory":{ "shape":"GenericString", "documentation":"

The memory capacity of the Amazon Web Services instance.

" }, "NetworkPerformance":{ "shape":"GenericString", "documentation":"

The network performance capacity of the Amazon Web Services instance.

" }, "Storage":{ "shape":"GenericString", "documentation":"

The disk storage of the Amazon Web Services instance. This doesn't include EBS storage.

" }, "Vcpu":{ "shape":"GenericString", "documentation":"

The number of VCPU cores in the Amazon Web Services instance type.

" } }, "documentation":"

Details on the Amazon EC2 Resource.

" }, "EC2ResourceUtilization":{ "type":"structure", "members":{ "MaxCpuUtilizationPercentage":{ "shape":"GenericString", "documentation":"

The maximum observed or expected CPU utilization of the instance.

" }, "MaxMemoryUtilizationPercentage":{ "shape":"GenericString", "documentation":"

The maximum observed or expected memory utilization of the instance.

" }, "MaxStorageUtilizationPercentage":{ "shape":"GenericString", "documentation":"

The maximum observed or expected storage utilization of the instance. This doesn't include EBS storage.

" }, "EBSResourceUtilization":{ "shape":"EBSResourceUtilization", "documentation":"

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

" }, "DiskResourceUtilization":{ "shape":"DiskResourceUtilization", "documentation":"

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

" }, "NetworkResourceUtilization":{ "shape":"NetworkResourceUtilization", "documentation":"

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

" } }, "documentation":"

Utilization metrics for the instance.

" }, "EC2Specification":{ "type":"structure", "members":{ "OfferingClass":{ "shape":"OfferingClass", "documentation":"

Indicates whether you want a recommendation for standard or convertible reservations.

" } }, "documentation":"

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

" }, "ESInstanceDetails":{ "type":"structure", "members":{ "InstanceClass":{ "shape":"GenericString", "documentation":"

The class of instance that Amazon Web Services recommends.

" }, "InstanceSize":{ "shape":"GenericString", "documentation":"

The size of instance that Amazon Web Services recommends.

" }, "Region":{ "shape":"GenericString", "documentation":"

The Amazon Web Services Region of the recommended reservation.

" }, "CurrentGeneration":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommendation is for a current-generation instance.

" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommended reservation is size flexible.

" } }, "documentation":"

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

" }, "ElastiCacheInstanceDetails":{ "type":"structure", "members":{ "Family":{ "shape":"GenericString", "documentation":"

The instance family of the recommended reservation.

" }, "NodeType":{ "shape":"GenericString", "documentation":"

The type of node that Amazon Web Services recommends.

" }, "Region":{ "shape":"GenericString", "documentation":"

The Amazon Web Services Region of the recommended reservation.

" }, "ProductDescription":{ "shape":"GenericString", "documentation":"

The description of the recommended reservation.

" }, "CurrentGeneration":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommendation is for a current generation instance.

" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommended reservation is size flexible.

" } }, "documentation":"

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

" }, "Entity":{"type":"string"}, "ErrorMessage":{"type":"string"}, "Estimated":{"type":"boolean"}, "Expression":{ "type":"structure", "members":{ "Or":{ "shape":"Expressions", "documentation":"

Return results that match either `Dimension` object.

" }, "And":{ "shape":"Expressions", "documentation":"

Return results that match both `Dimension` objects.

" }, "Not":{ "shape":"Expression", "documentation":"

Return results that don't match a `Dimension` object.

" }, "Dimensions":{ "shape":"DimensionValues", "documentation":"

The specific `Dimension` to use for `Expression`.

" }, "Tags":{ "shape":"TagValues", "documentation":"

The specific `Tag` to use for `Expression`.

" }, "CostCategories":{ "shape":"CostCategoryValues", "documentation":"

The filter that's based on `CostCategory` values.

" } }, "documentation":"

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\"`

For the `GetRightsizingRecommendation` action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to `LINKED_ACCOUNT`, `REGION`, or `RIGHTSIZING_TYPE`.

For the `GetReservationPurchaseRecommendation` action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to `LINKED_ACCOUNT`.

" }, "Expressions":{ "type":"list", "member":{"shape":"Expression"} }, "FindingReasonCode":{ "type":"string", "enum":[ "CPU_OVER_PROVISIONED", "CPU_UNDER_PROVISIONED", "MEMORY_OVER_PROVISIONED", "MEMORY_UNDER_PROVISIONED", "EBS_THROUGHPUT_OVER_PROVISIONED", "EBS_THROUGHPUT_UNDER_PROVISIONED", "EBS_IOPS_OVER_PROVISIONED", "EBS_IOPS_UNDER_PROVISIONED", "NETWORK_BANDWIDTH_OVER_PROVISIONED", "NETWORK_BANDWIDTH_UNDER_PROVISIONED", "NETWORK_PPS_OVER_PROVISIONED", "NETWORK_PPS_UNDER_PROVISIONED", "DISK_IOPS_OVER_PROVISIONED", "DISK_IOPS_UNDER_PROVISIONED", "DISK_THROUGHPUT_OVER_PROVISIONED", "DISK_THROUGHPUT_UNDER_PROVISIONED" ] }, "FindingReasonCodes":{ "type":"list", "member":{"shape":"FindingReasonCode"} }, "ForecastResult":{ "type":"structure", "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

The period of time that the forecast covers.

" }, "MeanValue":{ "shape":"GenericString", "documentation":"

The mean value of the forecast.

" }, "PredictionIntervalLowerBound":{ "shape":"GenericString", "documentation":"

The lower limit for the prediction interval.

" }, "PredictionIntervalUpperBound":{ "shape":"GenericString", "documentation":"

The upper limit for the prediction interval.

" } }, "documentation":"

The forecast that's created for your query.

" }, "ForecastResultsByTime":{ "type":"list", "member":{"shape":"ForecastResult"} }, "GenerationExistsException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

A request to generate a recommendation is already in progress.

", "exception":true }, "GenerationStatus":{ "type":"string", "enum":[ "SUCCEEDED", "PROCESSING", "FAILED" ] }, "GenerationSummary":{ "type":"structure", "members":{ "RecommendationId":{ "shape":"RecommendationId", "documentation":"

Indicates the ID for this specific recommendation.

" }, "GenerationStatus":{ "shape":"GenerationStatus", "documentation":"

Indicates whether the recommendation generation succeeded, is processing, or failed.

" }, "GenerationStartedTime":{ "shape":"ZonedDateTime", "documentation":"

Indicates the start time of the recommendation generation.

" }, "GenerationCompletionTime":{ "shape":"ZonedDateTime", "documentation":"

Indicates the completion time of the recommendation generation.

" }, "EstimatedCompletionTime":{ "shape":"ZonedDateTime", "documentation":"

Indicates the estimated time for when the recommendation generation will complete.

" } }, "documentation":"

The summary of the Savings Plans recommendation generation.

" }, "GenerationSummaryList":{ "type":"list", "member":{"shape":"GenerationSummary"} }, "GenericBoolean":{"type":"boolean"}, "GenericDouble":{"type":"double"}, "GenericString":{ "type":"string", "max":1024, "min":0, "pattern":"[\\S\\s]*" }, "GetAnomaliesRequest":{ "type":"structure", "required":["DateInterval"], "members":{ "MonitorArn":{ "shape":"GenericString", "documentation":"

Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon Resource Name (ARN).

" }, "DateInterval":{ "shape":"AnomalyDateInterval", "documentation":"

Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object will have an `AnomalyEndDate` in the specified time range.

" }, "Feedback":{ "shape":"AnomalyFeedbackType", "documentation":"

Filters anomaly results by the feedback field on the anomaly object.

" }, "TotalImpact":{ "shape":"TotalImpactFilter", "documentation":"

Filters anomaly results by the total impact field on the anomaly object. For example, you can filter anomalies `GREATER_THAN 200.00` to retrieve anomalies, with an estimated dollar impact greater than 200.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "MaxResults":{ "shape":"PageSize", "documentation":"

The number of entries a paginated response contains.

" } } }, "GetAnomaliesResponse":{ "type":"structure", "required":["Anomalies"], "members":{ "Anomalies":{ "shape":"Anomalies", "documentation":"

A list of cost anomalies.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetAnomalyMonitorsRequest":{ "type":"structure", "members":{ "MonitorArnList":{ "shape":"Values", "documentation":"

A list of cost anomaly monitor ARNs.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "MaxResults":{ "shape":"PageSize", "documentation":"

The number of entries that a paginated response contains.

" } } }, "GetAnomalyMonitorsResponse":{ "type":"structure", "required":["AnomalyMonitors"], "members":{ "AnomalyMonitors":{ "shape":"AnomalyMonitors", "documentation":"

A list of cost anomaly monitors that includes the detailed metadata for each monitor.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetAnomalySubscriptionsRequest":{ "type":"structure", "members":{ "SubscriptionArnList":{ "shape":"Values", "documentation":"

A list of cost anomaly subscription ARNs.

" }, "MonitorArn":{ "shape":"GenericString", "documentation":"

Cost anomaly monitor ARNs.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "MaxResults":{ "shape":"PageSize", "documentation":"

The number of entries a paginated response contains.

" } } }, "GetAnomalySubscriptionsResponse":{ "type":"structure", "required":["AnomalySubscriptions"], "members":{ "AnomalySubscriptions":{ "shape":"AnomalySubscriptions", "documentation":"

A list of cost anomaly subscriptions that includes the detailed metadata for each one.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetCostAndUsageRequest":{ "type":"structure", "required":[ "TimePeriod", "Granularity", "Metrics" ], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

Sets the start date and end date for retrieving Amazon Web Services costs. The start date is inclusive, but the end date is exclusive. For example, if `start` is `2017-01-01` and `end` is `2017-05-01`, then the cost and usage data is retrieved from `2017-01-01` up to and including `2017-04-30` but not including `2017-05-01`.

" }, "Granularity":{ "shape":"Granularity", "documentation":"

Sets the Amazon Web Services cost granularity to `MONTHLY` or `DAILY`, or `HOURLY`. If `Granularity` isn't set, the response object doesn't include the `Granularity`, either `MONTHLY` or `DAILY`, or `HOURLY`.

" }, "Filter":{ "shape":"Expression", "documentation":"

Filters Amazon Web Services costs by different dimensions. For example, you can specify `SERVICE` and `LINKED_ACCOUNT` and get the costs that are associated with that account's usage of that service. You can nest `Expression` objects to define any combination of dimension filters. For more information, see Expression.

Valid values for `MatchOptions` for `Dimensions` are `EQUALS` and `CASE_SENSITIVE`.

Valid values for `MatchOptions` for `CostCategories` and `Tags` are `EQUALS`, `ABSENT`, and `CASE_SENSITIVE`. Default values are `EQUALS` and `CASE_SENSITIVE`.

" }, "Metrics":{ "shape":"MetricNames", "documentation":"

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.

Valid values are `AmortizedCost`, `BlendedCost`, `NetAmortizedCost`, `NetUnblendedCost`, `NormalizedUsageAmount`, `UnblendedCost`, and `UsageQuantity`.

If you return the `UsageQuantity` metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate `usageQuantity` across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours and GB). To get more meaningful `UsageQuantity` metrics, filter by `UsageType` or `UsageTypeGroups`.

`Metrics` is required for `GetCostAndUsage` requests.

" }, "GroupBy":{ "shape":"GroupDefinitions", "documentation":"

You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

Valid values for the `DIMENSION` type are `AZ`, `INSTANCE_TYPE`, `LEGAL_ENTITY_NAME`, `INVOICING_ENTITY`, `LINKED_ACCOUNT`, `OPERATION`, `PLATFORM`, `PURCHASE_TYPE`, `SERVICE`, `TENANCY`, `RECORD_TYPE`, and `USAGE_TYPE`.

When you group by the `TAG` type and include a valid tag key, you get all tag values, including empty strings.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetCostAndUsageResponse":{ "type":"structure", "members":{ "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "GroupDefinitions":{ "shape":"GroupDefinitions", "documentation":"

The groups that are specified by the `Filter` or `GroupBy` parameters in the request.

" }, "ResultsByTime":{ "shape":"ResultsByTime", "documentation":"

The time period that's covered by the results in the response.

" }, "DimensionValueAttributes":{ "shape":"DimensionValuesWithAttributesList", "documentation":"

The attributes that apply to a specific dimension value. For example, if the value is a linked account, the attribute is that account name.

" } } }, "GetCostAndUsageWithResourcesRequest":{ "type":"structure", "required":[ "TimePeriod", "Granularity", "Filter" ], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

Sets the start and end dates for retrieving Amazon Web Services costs. The range must be within the last 14 days (the start date cannot be earlier than 14 days ago). The start date is inclusive, but the end date is exclusive. For example, if `start` is `2017-01-01` and `end` is `2017-05-01`, then the cost and usage data is retrieved from `2017-01-01` up to and including `2017-04-30` but not including `2017-05-01`.

" }, "Granularity":{ "shape":"Granularity", "documentation":"

Sets the Amazon Web Services cost granularity to `MONTHLY`, `DAILY`, or `HOURLY`. If `Granularity` isn't set, the response object doesn't include the `Granularity`, `MONTHLY`, `DAILY`, or `HOURLY`.

" }, "Filter":{ "shape":"Expression", "documentation":"

Filters Amazon Web Services costs by different dimensions. For example, you can specify `SERVICE` and `LINKED_ACCOUNT` and get the costs that are associated with that account's usage of that service. You can nest `Expression` objects to define any combination of dimension filters. For more information, see Expression.

The `GetCostAndUsageWithResources` operation requires that you either group by or filter by a `ResourceId`. It requires the Expression `\"SERVICE = Amazon Elastic Compute Cloud - Compute\"` in the filter.

Valid values for `MatchOptions` for `Dimensions` are `EQUALS` and `CASE_SENSITIVE`.

Valid values for `MatchOptions` for `CostCategories` and `Tags` are `EQUALS`, `ABSENT`, and `CASE_SENSITIVE`. Default values are `EQUALS` and `CASE_SENSITIVE`.

" }, "Metrics":{ "shape":"MetricNames", "documentation":"

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.

Valid values are `AmortizedCost`, `BlendedCost`, `NetAmortizedCost`, `NetUnblendedCost`, `NormalizedUsageAmount`, `UnblendedCost`, and `UsageQuantity`.

If you return the `UsageQuantity` metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate `usageQuantity` across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hour or GB). To get more meaningful `UsageQuantity` metrics, filter by `UsageType` or `UsageTypeGroups`.

`Metrics` is required for `GetCostAndUsageWithResources` requests.

" }, "GroupBy":{ "shape":"GroupDefinitions", "documentation":"

You can group Amazon Web Services costs using up to two different groups: `DIMENSION`, `TAG`, `COST_CATEGORY`.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetCostAndUsageWithResourcesResponse":{ "type":"structure", "members":{ "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "GroupDefinitions":{ "shape":"GroupDefinitions", "documentation":"

The groups that are specified by the `Filter` or `GroupBy` parameters in the request.

" }, "ResultsByTime":{ "shape":"ResultsByTime", "documentation":"

The time period that's covered by the results in the response.

" }, "DimensionValueAttributes":{ "shape":"DimensionValuesWithAttributesList", "documentation":"

The attributes that apply to a specific dimension value. For example, if the value is a linked account, the attribute is that account name.

" } } }, "GetCostCategoriesRequest":{ "type":"structure", "required":["TimePeriod"], "members":{ "SearchString":{ "shape":"SearchString", "documentation":"

The value that you want to search the filter values for.

If you don't specify a `CostCategoryName`, `SearchString` is used to filter Cost Category names that match the `SearchString` pattern. If you specify a `CostCategoryName`, `SearchString` is used to filter Cost Category values that match the `SearchString` pattern.

" }, "TimePeriod":{"shape":"DateInterval"}, "CostCategoryName":{"shape":"CostCategoryName"}, "Filter":{"shape":"Expression"}, "SortBy":{ "shape":"SortDefinitions", "documentation":"

The value that you sort the data by.

The key represents the cost and usage metrics. The following values are supported:

- `BlendedCost`

- `UnblendedCost`

- `AmortizedCost`

- `NetAmortizedCost`

- `NetUnblendedCost`

- `UsageQuantity`

- `NormalizedUsageAmount`

The supported key values for the `SortOrder` value are `ASCENDING` and `DESCENDING`.

When you use the `SortBy` value, the `NextPageToken` and `SearchString` key values aren't supported.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

This field is only used when the `SortBy` value is provided in the request.

The maximum number of objects that are returned for this request. If `MaxResults` isn't specified with the `SortBy` value, the request returns 1000 results as the default value for this parameter.

For `GetCostCategories`, MaxResults has an upper quota of 1000.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the previous call in your next request.

" } } }, "GetCostCategoriesResponse":{ "type":"structure", "required":[ "ReturnSize", "TotalSize" ], "members":{ "NextPageToken":{ "shape":"NextPageToken", "documentation":"

If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" }, "CostCategoryNames":{ "shape":"CostCategoryNamesList", "documentation":"

The names of the Cost Categories.

" }, "CostCategoryValues":{ "shape":"CostCategoryValuesList", "documentation":"

The Cost Category values.

If the `CostCategoryName` key isn't specified in the request, the `CostCategoryValues` fields aren't returned.

" }, "ReturnSize":{ "shape":"PageSize", "documentation":"

The number of objects that are returned.

" }, "TotalSize":{ "shape":"PageSize", "documentation":"

The total number of objects.

" } } }, "GetCostForecastRequest":{ "type":"structure", "required":[ "TimePeriod", "Metric", "Granularity" ], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

" }, "Metric":{ "shape":"Metric", "documentation":"

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.

Valid values for a `GetCostForecast` call are the following:

- AMORTIZED_COST

- BLENDED_COST

- NET_AMORTIZED_COST

- NET_UNBLENDED_COST

- UNBLENDED_COST

" }, "Granularity":{ "shape":"Granularity", "documentation":"

How granular you want the forecast to be. You can get 3 months of `DAILY` forecasts or 12 months of `MONTHLY` forecasts.

The `GetCostForecast` operation supports only `DAILY` and `MONTHLY` granularities.

" }, "Filter":{ "shape":"Expression", "documentation":"

The filters that you want to use to filter your forecast. The `GetCostForecast` API supports filtering by the following dimensions:

- `AZ`

- `INSTANCE_TYPE`

- `LINKED_ACCOUNT`

- `LINKED_ACCOUNT_NAME`

- `OPERATION`

- `PURCHASE_TYPE`

- `REGION`

- `SERVICE`

- `USAGE_TYPE`

- `USAGE_TYPE_GROUP`

- `RECORD_TYPE`

- `OPERATING_SYSTEM`

- `TENANCY`

- `SCOPE`

- `PLATFORM`

- `SUBSCRIPTION_ID`

- `LEGAL_ENTITY_NAME`

- `DEPLOYMENT_OPTION`

- `DATABASE_ENGINE`

- `INSTANCE_TYPE_FAMILY`

- `BILLING_ENTITY`

- `RESERVATION_ID`

- `SAVINGS_PLAN_ARN`

" }, "PredictionIntervalLevel":{ "shape":"PredictionIntervalLevel", "documentation":"

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

" } } }, "GetCostForecastResponse":{ "type":"structure", "members":{ "Total":{ "shape":"MetricValue", "documentation":"

How much you are forecasted to spend over the forecast period, in `USD`.

" }, "ForecastResultsByTime":{ "shape":"ForecastResultsByTime", "documentation":"

The forecasts for your query, in order. For `DAILY` forecasts, this is a list of days. For `MONTHLY` forecasts, this is a list of months.

" } } }, "GetDimensionValuesRequest":{ "type":"structure", "required":[ "TimePeriod", "Dimension" ], "members":{ "SearchString":{ "shape":"SearchString", "documentation":"

The value that you want to search the filter values for.

" }, "TimePeriod":{ "shape":"DateInterval", "documentation":"

The start date and end date for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if `start` is `2017-01-01` and `end` is `2017-05-01`, then the cost and usage data is retrieved from `2017-01-01` up to and including `2017-04-30` but not including `2017-05-01`.

" }, "Dimension":{ "shape":"Dimension", "documentation":"

The name of the dimension. Each `Dimension` is available for a different `Context`. For more information, see `Context`. `LINK_ACCOUNT_NAME` and `SERVICE_CODE` can only be used in CostCategoryRule.

" }, "Context":{ "shape":"Context", "documentation":"

The context for the call to `GetDimensionValues`. This can be `RESERVATIONS` or `COST_AND_USAGE`. The default value is `COST_AND_USAGE`. If the context is set to `RESERVATIONS`, the resulting dimension values can be used in the `GetReservationUtilization` operation. If the context is set to `COST_AND_USAGE`, the resulting dimension values can be used in the `GetCostAndUsage` operation.

If you set the context to `COST_AND_USAGE`, you can use the following dimensions for searching:

- AZ - The Availability Zone. An example is `us-east-1a`.

- BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:

  - Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.

  - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services in India.

  - Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on Amazon Web Services by third-party software providers.

- CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

- DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are `SingleAZ` and `MultiAZ`.

- DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

- INSTANCE_TYPE - The type of Amazon EC2 instance. An example is `m4.xlarge`.

- INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are `Compute Optimized` (for example, `C4`, `C5`, `C6g`, and `C7g`), `Memory Optimization` (for example, `R4`, `R5n`, `R5b`, and `R6g`).

- INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services invoice.

- LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

- LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.

- OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

- OPERATION - The action performed. Examples include `RunInstance` and `CreateBucket`.

- PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

- PURCHASE_TYPE - The reservation type of the purchase that this usage is related to. Examples include On-Demand Instances and Standard Reserved Instances.

- RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.

- SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

- SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).

- SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

- TENANCY - The tenancy of a resource. Examples are shared or dedicated.

- USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the `GetDimensionValues` operation includes a unit attribute. Examples include GB and Hrs.

- USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

- REGION - The Amazon Web Services Region.

- RECORD_TYPE - The different types of charges such as Reserved Instance (RI) fees, usage costs, tax refunds, and credits.

- RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

If you set the context to `RESERVATIONS`, you can use the following dimensions for searching:

- AZ - The Availability Zone. An example is `us-east-1a`.

- CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

- DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are `SingleAZ` and `MultiAZ`.

- INSTANCE_TYPE - The type of Amazon EC2 instance. An example is `m4.xlarge`.

- LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.

- PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

- REGION - The Amazon Web Services Region.

- SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

- TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

- TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to `SAVINGS_PLANS`, you can use the following dimensions for searching:

- SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

- PAYMENT_OPTION - The payment option for the given Savings Plans (for example, All Upfront)

- REGION - The Amazon Web Services Region.

- INSTANCE_TYPE_FAMILY - The family of instances (For example, `m5`)

- LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.

- SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

" }, "Filter":{"shape":"Expression"}, "SortBy":{ "shape":"SortDefinitions", "documentation":"

The value that you want to sort the data by.

The key represents cost and usage metrics. The following values are supported:

- `BlendedCost`

- `UnblendedCost`

- `AmortizedCost`

- `NetAmortizedCost`

- `NetUnblendedCost`

- `UsageQuantity`

- `NormalizedUsageAmount`

The supported values for the `SortOrder` key are `ASCENDING` or `DESCENDING`.

When you specify a `SortBy` paramater, the context must be `COST_AND_USAGE`. Further, when using `SortBy`, `NextPageToken` and `SearchString` aren't supported.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.

For `GetDimensionValues`, MaxResults has an upper limit of 1000.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetDimensionValuesResponse":{ "type":"structure", "required":[ "DimensionValues", "ReturnSize", "TotalSize" ], "members":{ "DimensionValues":{ "shape":"DimensionValuesWithAttributesList", "documentation":"

The filters that you used to filter your request. Some dimensions are available only for a specific context.

If you set the context to `COST_AND_USAGE`, you can use the following dimensions for searching:

- AZ - The Availability Zone. An example is `us-east-1a`.

- DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

- INSTANCE_TYPE - The type of Amazon EC2 instance. An example is `m4.xlarge`.

- LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

- LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.

- OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

- OPERATION - The action performed. Examples include `RunInstance` and `CreateBucket`.

- PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

- PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.

- SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

- USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the `GetDimensionValues` operation includes a unit attribute. Examples include GB and Hrs.

- USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

- RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

- RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service. You can opt-in by enabling `Hourly` and `Resource Level Data` in Cost Management Console preferences.

If you set the context to `RESERVATIONS`, you can use the following dimensions for searching:

- AZ - The Availability Zone. An example is `us-east-1a`.

- CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

- DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are `SingleAZ` and `MultiAZ`.

- INSTANCE_TYPE - The type of Amazon EC2 instance. An example is `m4.xlarge`.

- LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.

- PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

- REGION - The Amazon Web Services Region.

- SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

- TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

- TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to `SAVINGS_PLANS`, you can use the following dimensions for searching:

- SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

- PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

- REGION - The Amazon Web Services Region.

- INSTANCE_TYPE_FAMILY - The family of instances (For example, `m5`)

- LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.

- SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

" }, "ReturnSize":{ "shape":"PageSize", "documentation":"

The number of results that Amazon Web Services returned at one time.

" }, "TotalSize":{ "shape":"PageSize", "documentation":"

The total number of search results.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetReservationCoverageRequest":{ "type":"structure", "required":["TimePeriod"], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if `start` is `2017-01-01` and `end` is `2017-05-01`, then the cost and usage data is retrieved from `2017-01-01` up to and including `2017-04-30` but not including `2017-05-01`.

" }, "GroupBy":{ "shape":"GroupDefinitions", "documentation":"

You can group the data by the following attributes:

- AZ

- CACHE_ENGINE

- DATABASE_ENGINE

- DEPLOYMENT_OPTION

- INSTANCE_TYPE

- INVOICING_ENTITY

- LINKED_ACCOUNT

- OPERATING_SYSTEM

- PLATFORM

- REGION

- TENANCY

" }, "Granularity":{ "shape":"Granularity", "documentation":"

The granularity of the Amazon Web Services cost data for the reservation. Valid values are `MONTHLY` and `DAILY`.

If `GroupBy` is set, `Granularity` can't be set. If `Granularity` isn't set, the response object doesn't include `Granularity`, either `MONTHLY` or `DAILY`.

The `GetReservationCoverage` operation supports only `DAILY` and `MONTHLY` granularities.

" }, "Filter":{ "shape":"Expression", "documentation":"

Filters utilization data by dimensions. You can filter by the following dimensions:

- AZ

- CACHE_ENGINE

- DATABASE_ENGINE

- DEPLOYMENT_OPTION

- INSTANCE_TYPE

- LINKED_ACCOUNT

- OPERATING_SYSTEM

- PLATFORM

- REGION

- SERVICE

- TAG

- TENANCY

`GetReservationCoverage` uses the same Expression object as the other operations, but only `AND` is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a `SERVICE` filter, Cost Explorer defaults to EC2.

Cost category is also supported.

" }, "Metrics":{ "shape":"MetricNames", "documentation":"

The measurement that you want your reservation coverage reported in.

Valid values are `Hour`, `Unit`, and `Cost`. You can use multiple values in a request.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "SortBy":{ "shape":"SortDefinition", "documentation":"

The value by which you want to sort the data.

The following values are supported for `Key`:

- `OnDemandCost`

- `CoverageHoursPercentage`

- `OnDemandHours`

- `ReservedHours`

- `TotalRunningHours`

- `CoverageNormalizedUnitsPercentage`

- `OnDemandNormalizedUnits`

- `ReservedNormalizedUnits`

- `TotalRunningNormalizedUnits`

- `Time`

Supported values for `SortOrder` are `ASCENDING` or `DESCENDING`.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

", "box":true } }, "documentation":"

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

" }, "GetReservationCoverageResponse":{ "type":"structure", "required":["CoveragesByTime"], "members":{ "CoveragesByTime":{ "shape":"CoveragesByTime", "documentation":"

The amount of time that your reservations covered.

" }, "Total":{ "shape":"Coverage", "documentation":"

The total amount of instance usage that a reservation covered.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetReservationPurchaseRecommendationRequest":{ "type":"structure", "required":["Service"], "members":{ "AccountId":{ "shape":"GenericString", "documentation":"

The account ID that's associated with the recommendation.

" }, "Service":{ "shape":"GenericString", "documentation":"

The specific service that you want recommendations for.

" }, "Filter":{"shape":"Expression"}, "AccountScope":{ "shape":"AccountScope", "documentation":"

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to `PAYER`. If the value is `LINKED`, recommendations are calculated for individual member accounts only.

" }, "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", "documentation":"

The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.

" }, "TermInYears":{ "shape":"TermInYears", "documentation":"

The reservation term that you want recommendations for.

" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The reservation purchase option that you want recommendations for.

" }, "ServiceSpecification":{ "shape":"ServiceSpecification", "documentation":"

The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

" }, "PageSize":{ "shape":"NonNegativeInteger", "documentation":"

The number of recommendations that you want returned in a single response object.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The pagination token that indicates the next set of results that you want to retrieve.

" } } }, "GetReservationPurchaseRecommendationResponse":{ "type":"structure", "members":{ "Metadata":{ "shape":"ReservationPurchaseRecommendationMetadata", "documentation":"

Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.

" }, "Recommendations":{ "shape":"ReservationPurchaseRecommendations", "documentation":"

Recommendations for reservations to purchase.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The pagination token for the next set of retrievable results.

" } } }, "GetReservationUtilizationRequest":{ "type":"structure", "required":["TimePeriod"], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if `start` is `2017-01-01` and `end` is `2017-05-01`, then the cost and usage data is retrieved from `2017-01-01` up to and including `2017-04-30` but not including `2017-05-01`.

" }, "GroupBy":{ "shape":"GroupDefinitions", "documentation":"

Groups only by `SUBSCRIPTION_ID`. Metadata is included.

" }, "Granularity":{ "shape":"Granularity", "documentation":"

If `GroupBy` is set, `Granularity` can't be set. If `Granularity` isn't set, the response object doesn't include `Granularity`, either `MONTHLY` or `DAILY`. If both `GroupBy` and `Granularity` aren't set, `GetReservationUtilization` defaults to `DAILY`.

The `GetReservationUtilization` operation supports only `DAILY` and `MONTHLY` granularities.

" }, "Filter":{ "shape":"Expression", "documentation":"

Filters utilization data by dimensions. You can filter by the following dimensions:

- AZ

- CACHE_ENGINE

- DEPLOYMENT_OPTION

- INSTANCE_TYPE

- LINKED_ACCOUNT

- OPERATING_SYSTEM

- PLATFORM

- REGION

- SERVICE

- SCOPE

- TENANCY

`GetReservationUtilization` uses the same Expression object as the other operations, but only `AND` is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

" }, "SortBy":{ "shape":"SortDefinition", "documentation":"

The value that you want to sort the data by.

The following values are supported for `Key`:

- `UtilizationPercentage`

- `UtilizationPercentageInUnits`

- `PurchasedHours`

- `PurchasedUnits`

- `TotalActualHours`

- `TotalActualUnits`

- `UnusedHours`

- `UnusedUnits`

- `OnDemandCostOfRIHoursUsed`

- `NetRISavings`

- `TotalPotentialRISavings`

- `AmortizedUpfrontFee`

- `AmortizedRecurringFee`

- `TotalAmortizedFee`

- `RICostForUnusedHours`

- `RealizedSavings`

- `UnrealizedSavings`

The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

", "box":true } } }, "GetReservationUtilizationResponse":{ "type":"structure", "required":["UtilizationsByTime"], "members":{ "UtilizationsByTime":{ "shape":"UtilizationsByTime", "documentation":"

The amount of time that you used your Reserved Instances (RIs).

" }, "Total":{ "shape":"ReservationAggregates", "documentation":"

The total amount of time that you used your Reserved Instances (RIs).

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetRightsizingRecommendationRequest":{ "type":"structure", "required":["Service"], "members":{ "Filter":{"shape":"Expression"}, "Configuration":{ "shape":"RightsizingRecommendationConfiguration", "documentation":"

You can use Configuration 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 RI benefits, or neither.

" }, "Service":{ "shape":"GenericString", "documentation":"

The specific service that you want recommendations for. The only valid value for `GetRightsizingRecommendation` is \"`AmazonEC2`\".

" }, "PageSize":{ "shape":"NonNegativeInteger", "documentation":"

The number of recommendations that you want returned in a single response object.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The pagination token that indicates the next set of results that you want to retrieve.

" } } }, "GetRightsizingRecommendationResponse":{ "type":"structure", "members":{ "Metadata":{ "shape":"RightsizingRecommendationMetadata", "documentation":"

Information regarding this specific recommendation set.

" }, "Summary":{ "shape":"RightsizingRecommendationSummary", "documentation":"

Summary of this recommendation set.

" }, "RightsizingRecommendations":{ "shape":"RightsizingRecommendationList", "documentation":"

Recommendations to rightsize resources.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results.

" }, "Configuration":{ "shape":"RightsizingRecommendationConfiguration", "documentation":"

You can use Configuration 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 RI benefits, or neither.

" } } }, "GetSavingsPlanPurchaseRecommendationDetailsRequest":{ "type":"structure", "required":["RecommendationDetailId"], "members":{ "RecommendationDetailId":{ "shape":"RecommendationDetailId", "documentation":"

The ID that is associated with the Savings Plan recommendation.

" } } }, "GetSavingsPlanPurchaseRecommendationDetailsResponse":{ "type":"structure", "members":{ "RecommendationDetailId":{ "shape":"RecommendationDetailId", "documentation":"

The ID that is associated with the Savings Plan recommendation.

" }, "RecommendationDetailData":{ "shape":"RecommendationDetailData", "documentation":"

Contains detailed information about a specific Savings Plan recommendation.

" } } }, "GetSavingsPlansCoverageRequest":{ "type":"structure", "required":["TimePeriod"], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

The time period that you want the usage and costs for. The `Start` date must be within 13 months. The `End` date must be after the `Start` date, and before the current date. Future dates can't be used as an `End` date.

" }, "GroupBy":{ "shape":"GroupDefinitions", "documentation":"

You can group the data using the attributes `INSTANCE_FAMILY`, `REGION`, or `SERVICE`.

" }, "Granularity":{ "shape":"Granularity", "documentation":"

The granularity of the Amazon Web Services cost data for your Savings Plans. `Granularity` can't be set if `GroupBy` is set.

The `GetSavingsPlansCoverage` operation supports only `DAILY` and `MONTHLY` granularities.

" }, "Filter":{ "shape":"Expression", "documentation":"

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

- `LINKED_ACCOUNT`

- `REGION`

- `SERVICE`

- `INSTANCE_FAMILY`

`GetSavingsPlansCoverage` uses the same Expression object as the other operations, but only `AND` is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

" }, "Metrics":{ "shape":"MetricNames", "documentation":"

The measurement that you want your Savings Plans coverage reported in. The only valid value is `SpendCoveredBySavingsPlans`.

" }, "NextToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to be returned in a response. The default is `20`, with a minimum value of `1`.

", "box":true }, "SortBy":{ "shape":"SortDefinition", "documentation":"

The value that you want to sort the data by.

The following values are supported for `Key`:

- `SpendCoveredBySavingsPlan`

- `OnDemandCost`

- `CoveragePercentage`

- `TotalCost`

- `InstanceFamily`

- `Region`

- `Service`

The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.

" } } }, "GetSavingsPlansCoverageResponse":{ "type":"structure", "required":["SavingsPlansCoverages"], "members":{ "SavingsPlansCoverages":{ "shape":"SavingsPlansCoverages", "documentation":"

The amount of spend that your Savings Plans covered.

" }, "NextToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetSavingsPlansPurchaseRecommendationRequest":{ "type":"structure", "required":[ "SavingsPlansType", "TermInYears", "PaymentOption", "LookbackPeriodInDays" ], "members":{ "SavingsPlansType":{ "shape":"SupportedSavingsPlansType", "documentation":"

The Savings Plans recommendation type that's requested.

" }, "TermInYears":{ "shape":"TermInYears", "documentation":"

The savings plan recommendation term that's used to generate these recommendations.

" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The payment option that's used to generate these recommendations.

" }, "AccountScope":{ "shape":"AccountScope", "documentation":"

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to `PAYER`. If the value is `LINKED`, recommendations are calculated for individual member accounts only.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "PageSize":{ "shape":"NonNegativeInteger", "documentation":"

The number of recommendations that you want returned in a single response object.

" }, "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", "documentation":"

The lookback period that's used to generate the recommendation.

" }, "Filter":{ "shape":"Expression", "documentation":"

You can filter your recommendations by Account ID with the `LINKED_ACCOUNT` dimension. To filter your recommendations by Account ID, specify `Key` as `LINKED_ACCOUNT` and `Value` as the comma-separated Acount ID(s) that you want to see Savings Plans purchase recommendations for.

For GetSavingsPlansPurchaseRecommendation, the `Filter` doesn't include `CostCategories` or `Tags`. It only includes `Dimensions`. With `Dimensions`, `Key` must be `LINKED_ACCOUNT` and `Value` can be a single Account ID or multiple comma-separated Account IDs that you want to see Savings Plans Purchase Recommendations for. `AND` and `OR` operators are not supported.

" } } }, "GetSavingsPlansPurchaseRecommendationResponse":{ "type":"structure", "members":{ "Metadata":{ "shape":"SavingsPlansPurchaseRecommendationMetadata", "documentation":"

Information that regards this specific recommendation set.

" }, "SavingsPlansPurchaseRecommendation":{ "shape":"SavingsPlansPurchaseRecommendation", "documentation":"

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

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetSavingsPlansUtilizationDetailsRequest":{ "type":"structure", "required":["TimePeriod"], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

The time period that you want the usage and costs for. The `Start` date must be within 13 months. The `End` date must be after the `Start` date, and before the current date. Future dates can't be used as an `End` date.

" }, "Filter":{ "shape":"Expression", "documentation":"

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

- `LINKED_ACCOUNT`

- `SAVINGS_PLAN_ARN`

- `REGION`

- `PAYMENT_OPTION`

- `INSTANCE_TYPE_FAMILY`

`GetSavingsPlansUtilizationDetails` uses the same Expression object as the other operations, but only `AND` is supported among each dimension.

" }, "DataType":{ "shape":"SavingsPlansDataTypes", "documentation":"

The data type.

" }, "NextToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to be returned in a response. The default is `20`, with a minimum value of `1`.

", "box":true }, "SortBy":{ "shape":"SortDefinition", "documentation":"

The value that you want to sort the data by.

The following values are supported for `Key`:

- `UtilizationPercentage`

- `TotalCommitment`

- `UsedCommitment`

- `UnusedCommitment`

- `NetSavings`

- `AmortizedRecurringCommitment`

- `AmortizedUpfrontCommitment`

The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.

" } } }, "GetSavingsPlansUtilizationDetailsResponse":{ "type":"structure", "required":[ "SavingsPlansUtilizationDetails", "TimePeriod" ], "members":{ "SavingsPlansUtilizationDetails":{ "shape":"SavingsPlansUtilizationDetails", "documentation":"

Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.

" }, "Total":{ "shape":"SavingsPlansUtilizationAggregates", "documentation":"

The total Savings Plans utilization, regardless of time period.

" }, "TimePeriod":{"shape":"DateInterval"}, "NextToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetSavingsPlansUtilizationRequest":{ "type":"structure", "required":["TimePeriod"], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

The time period that you want the usage and costs for. The `Start` date must be within 13 months. The `End` date must be after the `Start` date, and before the current date. Future dates can't be used as an `End` date.

" }, "Granularity":{ "shape":"Granularity", "documentation":"

The granularity of the Amazon Web Services utillization data for your Savings Plans.

The `GetSavingsPlansUtilization` operation supports only `DAILY` and `MONTHLY` granularities.

" }, "Filter":{ "shape":"Expression", "documentation":"

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

- `LINKED_ACCOUNT`

- `SAVINGS_PLAN_ARN`

- `SAVINGS_PLANS_TYPE`

- `REGION`

- `PAYMENT_OPTION`

- `INSTANCE_TYPE_FAMILY`

`GetSavingsPlansUtilization` uses the same Expression object as the other operations, but only `AND` is supported among each dimension.

" }, "SortBy":{ "shape":"SortDefinition", "documentation":"

The value that you want to sort the data by.

The following values are supported for `Key`:

- `UtilizationPercentage`

- `TotalCommitment`

- `UsedCommitment`

- `UnusedCommitment`

- `NetSavings`

The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.

" } } }, "GetSavingsPlansUtilizationResponse":{ "type":"structure", "required":["Total"], "members":{ "SavingsPlansUtilizationsByTime":{ "shape":"SavingsPlansUtilizationsByTime", "documentation":"

The amount of cost/commitment that you used your Savings Plans. You can use it to specify date ranges.

" }, "Total":{ "shape":"SavingsPlansUtilizationAggregates", "documentation":"

The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.

" } } }, "GetTagsRequest":{ "type":"structure", "required":["TimePeriod"], "members":{ "SearchString":{ "shape":"SearchString", "documentation":"

The value that you want to search for.

" }, "TimePeriod":{ "shape":"DateInterval", "documentation":"

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if `start` is `2017-01-01` and `end` is `2017-05-01`, then the cost and usage data is retrieved from `2017-01-01` up to and including `2017-04-30` but not including `2017-05-01`.

" }, "TagKey":{ "shape":"TagKey", "documentation":"

The key of the tag that you want to return values for.

" }, "Filter":{"shape":"Expression"}, "SortBy":{ "shape":"SortDefinitions", "documentation":"

The value that you want to sort the data by.

The key represents cost and usage metrics. The following values are supported:

- `BlendedCost`

- `UnblendedCost`

- `AmortizedCost`

- `NetAmortizedCost`

- `NetUnblendedCost`

- `UsageQuantity`

- `NormalizedUsageAmount`

The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.

When you use `SortBy`, `NextPageToken` and `SearchString` aren't supported.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.

For `GetTags`, MaxResults has an upper quota of 1000.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "GetTagsResponse":{ "type":"structure", "required":[ "Tags", "ReturnSize", "TotalSize" ], "members":{ "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags that match your request.

" }, "ReturnSize":{ "shape":"PageSize", "documentation":"

The number of query results that Amazon Web Services returns at a time.

" }, "TotalSize":{ "shape":"PageSize", "documentation":"

The total number of query results.

" } } }, "GetUsageForecastRequest":{ "type":"structure", "required":[ "TimePeriod", "Metric", "Granularity" ], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. For example, if `start` is `2017-01-01` and `end` is `2017-05-01`, then the cost and usage data is retrieved from `2017-01-01` up to and including `2017-04-30` but not including `2017-05-01`. The start date must be equal to or later than the current date to avoid a validation error.

" }, "Metric":{ "shape":"Metric", "documentation":"

Which metric Cost Explorer uses to create your forecast.

Valid values for a `GetUsageForecast` call are the following:

- USAGE_QUANTITY

- NORMALIZED_USAGE_AMOUNT

" }, "Granularity":{ "shape":"Granularity", "documentation":"

How granular you want the forecast to be. You can get 3 months of `DAILY` forecasts or 12 months of `MONTHLY` forecasts.

The `GetUsageForecast` operation supports only `DAILY` and `MONTHLY` granularities.

" }, "Filter":{ "shape":"Expression", "documentation":"

The filters that you want to use to filter your forecast. The `GetUsageForecast` API supports filtering by the following dimensions:

- `AZ`

- `INSTANCE_TYPE`

- `LINKED_ACCOUNT`

- `LINKED_ACCOUNT_NAME`

- `OPERATION`

- `PURCHASE_TYPE`

- `REGION`

- `SERVICE`

- `USAGE_TYPE`

- `USAGE_TYPE_GROUP`

- `RECORD_TYPE`

- `OPERATING_SYSTEM`

- `TENANCY`

- `SCOPE`

- `PLATFORM`

- `SUBSCRIPTION_ID`

- `LEGAL_ENTITY_NAME`

- `DEPLOYMENT_OPTION`

- `DATABASE_ENGINE`

- `INSTANCE_TYPE_FAMILY`

- `BILLING_ENTITY`

- `RESERVATION_ID`

- `SAVINGS_PLAN_ARN`

" }, "PredictionIntervalLevel":{ "shape":"PredictionIntervalLevel", "documentation":"

Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

" } } }, "GetUsageForecastResponse":{ "type":"structure", "members":{ "Total":{ "shape":"MetricValue", "documentation":"

How much you're forecasted to use over the forecast period.

" }, "ForecastResultsByTime":{ "shape":"ForecastResultsByTime", "documentation":"

The forecasts for your query, in order. For `DAILY` forecasts, this is a list of days. For `MONTHLY` forecasts, this is a list of months.

" } } }, "Granularity":{ "type":"string", "enum":[ "DAILY", "MONTHLY", "HOURLY" ] }, "Group":{ "type":"structure", "members":{ "Keys":{ "shape":"Keys", "documentation":"

The keys that are included in this group.

" }, "Metrics":{ "shape":"Metrics", "documentation":"

The metrics that are included in this group.

" } }, "documentation":"

One level of grouped data in the results.

" }, "GroupDefinition":{ "type":"structure", "members":{ "Type":{ "shape":"GroupDefinitionType", "documentation":"

The string that represents the type of group.

" }, "Key":{ "shape":"GroupDefinitionKey", "documentation":"

The string that represents a key for a specified group.

" } }, "documentation":"

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

" }, "GroupDefinitionKey":{ "type":"string", "max":1024, "min":0, "pattern":"[\\S\\s]*" }, "GroupDefinitionType":{ "type":"string", "enum":[ "DIMENSION", "TAG", "COST_CATEGORY" ] }, "GroupDefinitions":{ "type":"list", "member":{"shape":"GroupDefinition"} }, "Groups":{ "type":"list", "member":{"shape":"Group"} }, "Impact":{ "type":"structure", "required":["MaxImpact"], "members":{ "MaxImpact":{ "shape":"GenericDouble", "documentation":"

The maximum dollar value that's observed for an anomaly.

" }, "TotalImpact":{ "shape":"GenericDouble", "documentation":"

The cumulative dollar difference between the total actual spend and total expected spend. It is calculated as `TotalActualSpend - TotalExpectedSpend`.

" }, "TotalActualSpend":{ "shape":"NullableNonNegativeDouble", "documentation":"

The cumulative dollar amount that was actually spent during the anomaly.

" }, "TotalExpectedSpend":{ "shape":"NullableNonNegativeDouble", "documentation":"

The cumulative dollar amount that was expected to be spent during the anomaly. It is calculated using advanced machine learning models to determine the typical spending pattern based on historical data for a customer.

" }, "TotalImpactPercentage":{ "shape":"NullableNonNegativeDouble", "documentation":"

The cumulative percentage difference between the total actual spend and total expected spend. It is calculated as `(TotalImpact / TotalExpectedSpend) * 100`. When `TotalExpectedSpend` is zero, this field is omitted. Expected spend can be zero in situations such as when you start to use a service for the first time.

" } }, "documentation":"

The dollar value of the anomaly.

" }, "InstanceDetails":{ "type":"structure", "members":{ "EC2InstanceDetails":{ "shape":"EC2InstanceDetails", "documentation":"

The Amazon EC2 reservations that Amazon Web Services recommends that you purchase.

" }, "RDSInstanceDetails":{ "shape":"RDSInstanceDetails", "documentation":"

The Amazon RDS reservations that Amazon Web Services recommends that you purchase.

" }, "RedshiftInstanceDetails":{ "shape":"RedshiftInstanceDetails", "documentation":"

The Amazon Redshift reservations that Amazon Web Services recommends that you purchase.

" }, "ElastiCacheInstanceDetails":{ "shape":"ElastiCacheInstanceDetails", "documentation":"

The ElastiCache reservations that Amazon Web Services recommends that you purchase.

" }, "ESInstanceDetails":{ "shape":"ESInstanceDetails", "documentation":"

The Amazon OpenSearch Service reservations that Amazon Web Services recommends that you purchase.

" }, "MemoryDBInstanceDetails":{ "shape":"MemoryDBInstanceDetails", "documentation":"

The MemoryDB reservations that Amazon Web Services recommends that you purchase.

" } }, "documentation":"

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

" }, "InvalidNextTokenException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

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

", "exception":true }, "Key":{"type":"string"}, "Keys":{ "type":"list", "member":{"shape":"Key"} }, "LimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

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

", "exception":true }, "ListCostAllocationTagsRequest":{ "type":"structure", "members":{ "Status":{ "shape":"CostAllocationTagStatus", "documentation":"

The status of cost allocation tag keys that are returned for this request.

" }, "TagKeys":{ "shape":"CostAllocationTagKeyList", "documentation":"

The list of cost allocation tag keys that are returned for this request.

" }, "Type":{ "shape":"CostAllocationTagType", "documentation":"

The type of `CostAllocationTag` object that are returned for this request. The `AWSGenerated` type tags are tags that Amazon Web Services defines and applies to support Amazon Web Services resources for cost allocation purposes. The `UserDefined` type tags are tags that you define, create, and apply to resources.

" }, "NextToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "MaxResults":{ "shape":"CostAllocationTagsMaxResults", "documentation":"

The maximum number of objects that are returned for this request. By default, the request returns 100 results.

", "box":true } } }, "ListCostAllocationTagsResponse":{ "type":"structure", "members":{ "CostAllocationTags":{ "shape":"CostAllocationTagList", "documentation":"

A list of cost allocation tags that includes the detailed metadata for each one.

" }, "NextToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "ListCostCategoryDefinitionsRequest":{ "type":"structure", "members":{ "EffectiveOn":{ "shape":"ZonedDateTime", "documentation":"

The date when the Cost Category was effective.

" }, "NextToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" }, "MaxResults":{ "shape":"CostCategoryMaxResults", "documentation":"

The number of entries a paginated response contains.

", "box":true } } }, "ListCostCategoryDefinitionsResponse":{ "type":"structure", "members":{ "CostCategoryReferences":{ "shape":"CostCategoryReferencesList", "documentation":"

A reference to a Cost Category that contains enough information to identify the Cost Category.

" }, "NextToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } }, "ListSavingsPlansPurchaseRecommendationGenerationRequest":{ "type":"structure", "members":{ "GenerationStatus":{ "shape":"GenerationStatus", "documentation":"

The status of the recommendation generation.

" }, "RecommendationIds":{ "shape":"RecommendationIdList", "documentation":"

The IDs for each specific recommendation.

" }, "PageSize":{ "shape":"NonNegativeInteger", "documentation":"

The number of recommendations that you want returned in a single response object.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results.

" } } }, "ListSavingsPlansPurchaseRecommendationGenerationResponse":{ "type":"structure", "members":{ "GenerationSummaryList":{ "shape":"GenerationSummaryList", "documentation":"

The list of historical recommendation generations.

" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"

The token to retrieve the next set of results.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "ResourceTags":{ "shape":"ResourceTagList", "documentation":"

A list of tag key value pairs that are associated with the resource.

" } } }, "LookbackPeriodInDays":{ "type":"string", "enum":[ "SEVEN_DAYS", "THIRTY_DAYS", "SIXTY_DAYS" ] }, "MatchOption":{ "type":"string", "enum":[ "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "CASE_SENSITIVE", "CASE_INSENSITIVE", "GREATER_THAN_OR_EQUAL" ] }, "MatchOptions":{ "type":"list", "member":{"shape":"MatchOption"} }, "MaxResults":{ "type":"integer", "min":1 }, "MemoryDBInstanceDetails":{ "type":"structure", "members":{ "Family":{ "shape":"GenericString", "documentation":"

The instance family of the recommended reservation.

" }, "NodeType":{ "shape":"GenericString", "documentation":"

The node type of the recommended reservation.

" }, "Region":{ "shape":"GenericString", "documentation":"

The Amazon Web Services Region of the recommended reservation.

" }, "CurrentGeneration":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommendation is for a current generation instance.

" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommended reservation is size flexible.

" } }, "documentation":"

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

" }, "Metric":{ "type":"string", "enum":[ "BLENDED_COST", "UNBLENDED_COST", "AMORTIZED_COST", "NET_UNBLENDED_COST", "NET_AMORTIZED_COST", "USAGE_QUANTITY", "NORMALIZED_USAGE_AMOUNT" ] }, "MetricAmount":{"type":"string"}, "MetricName":{ "type":"string", "max":1024, "min":0, "pattern":"[\\S\\s]*" }, "MetricNames":{ "type":"list", "member":{"shape":"MetricName"} }, "MetricUnit":{"type":"string"}, "MetricValue":{ "type":"structure", "members":{ "Amount":{ "shape":"MetricAmount", "documentation":"

The actual number that represents the metric.

" }, "Unit":{ "shape":"MetricUnit", "documentation":"

The unit that the metric is given in.

" } }, "documentation":"

The aggregated value for a metric.

" }, "Metrics":{ "type":"map", "key":{"shape":"MetricName"}, "value":{"shape":"MetricValue"} }, "MetricsOverLookbackPeriod":{ "type":"list", "member":{"shape":"RecommendationDetailHourlyMetrics"} }, "ModifyRecommendationDetail":{ "type":"structure", "members":{ "TargetInstances":{ "shape":"TargetInstancesList", "documentation":"

Determines whether this instance type is the Amazon Web Services default recommendation.

" } }, "documentation":"

Details for the modification recommendation.

" }, "MonitorArnList":{ "type":"list", "member":{"shape":"Arn"} }, "MonitorDimension":{ "type":"string", "enum":["SERVICE"] }, "MonitorType":{ "type":"string", "enum":[ "DIMENSIONAL", "CUSTOM" ] }, "NetRISavings":{"type":"string"}, "NetworkResourceUtilization":{ "type":"structure", "members":{ "NetworkInBytesPerSecond":{ "shape":"GenericString", "documentation":"

The network inbound throughput utilization measured in Bytes per second (Bps).

" }, "NetworkOutBytesPerSecond":{ "shape":"GenericString", "documentation":"

The network outbound throughput utilization measured in Bytes per second (Bps).

" }, "NetworkPacketsInPerSecond":{ "shape":"GenericString", "documentation":"

The network inbound packets that are measured in packets per second.

" }, "NetworkPacketsOutPerSecond":{ "shape":"GenericString", "documentation":"

The network outbound packets that are measured in packets per second.

" } }, "documentation":"

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

" }, "NextPageToken":{ "type":"string", "max":8192, "min":0, "pattern":"[\\S\\s]*" }, "NonNegativeInteger":{ "type":"integer", "min":0 }, "NullableNonNegativeDouble":{ "type":"double", "min":0.0 }, "NumericOperator":{ "type":"string", "enum":[ "EQUAL", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "GREATER_THAN", "LESS_THAN", "BETWEEN" ] }, "OfferingClass":{ "type":"string", "enum":[ "STANDARD", "CONVERTIBLE" ] }, "OnDemandCost":{"type":"string"}, "OnDemandCostOfRIHoursUsed":{"type":"string"}, "OnDemandHours":{"type":"string"}, "OnDemandNormalizedUnits":{"type":"string"}, "PageSize":{"type":"integer"}, "PaymentOption":{ "type":"string", "enum":[ "NO_UPFRONT", "PARTIAL_UPFRONT", "ALL_UPFRONT", "LIGHT_UTILIZATION", "MEDIUM_UTILIZATION", "HEAVY_UTILIZATION" ] }, "PlatformDifference":{ "type":"string", "enum":[ "HYPERVISOR", "NETWORK_INTERFACE", "STORAGE_INTERFACE", "INSTANCE_STORE_AVAILABILITY", "VIRTUALIZATION_TYPE" ] }, "PlatformDifferences":{ "type":"list", "member":{"shape":"PlatformDifference"} }, "PredictionIntervalLevel":{ "type":"integer", "max":99, "min":51 }, "ProvideAnomalyFeedbackRequest":{ "type":"structure", "required":[ "AnomalyId", "Feedback" ], "members":{ "AnomalyId":{ "shape":"GenericString", "documentation":"

A cost anomaly ID.

" }, "Feedback":{ "shape":"AnomalyFeedbackType", "documentation":"

Describes whether the cost anomaly was a planned activity or you considered it an anomaly.

" } } }, "ProvideAnomalyFeedbackResponse":{ "type":"structure", "required":["AnomalyId"], "members":{ "AnomalyId":{ "shape":"GenericString", "documentation":"

The ID of the modified cost anomaly.

" } } }, "PurchasedHours":{"type":"string"}, "PurchasedUnits":{"type":"string"}, "RDSInstanceDetails":{ "type":"structure", "members":{ "Family":{ "shape":"GenericString", "documentation":"

The instance family of the recommended reservation.

" }, "InstanceType":{ "shape":"GenericString", "documentation":"

The type of instance that Amazon Web Services recommends.

" }, "Region":{ "shape":"GenericString", "documentation":"

The Amazon Web Services Region of the recommended reservation.

" }, "DatabaseEngine":{ "shape":"GenericString", "documentation":"

The database engine that the recommended reservation supports.

" }, "DatabaseEdition":{ "shape":"GenericString", "documentation":"

The database edition that the recommended reservation supports.

" }, "DeploymentOption":{ "shape":"GenericString", "documentation":"

Determines whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.

" }, "LicenseModel":{ "shape":"GenericString", "documentation":"

The license model that the recommended reservation supports.

" }, "CurrentGeneration":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommendation is for a current-generation instance.

" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommended reservation is size flexible.

" } }, "documentation":"

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

" }, "RICostForUnusedHours":{"type":"string"}, "RealizedSavings":{"type":"string"}, "RecommendationDetailData":{ "type":"structure", "members":{ "AccountScope":{ "shape":"AccountScope", "documentation":"

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

" }, "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", "documentation":"

How many days of previous usage that Amazon Web Services considers when making this recommendation.

" }, "SavingsPlansType":{ "shape":"SupportedSavingsPlansType", "documentation":"

The requested Savings Plan recommendation type.

" }, "TermInYears":{ "shape":"TermInYears", "documentation":"

The term of the commitment in years.

" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The payment option for the commitment (for example, All Upfront or No Upfront).

" }, "AccountId":{ "shape":"GenericString", "documentation":"

The AccountID that the recommendation is generated for.

" }, "CurrencyCode":{ "shape":"GenericString", "documentation":"

The currency code that Amazon Web Services used to generate the recommendation and present potential savings.

" }, "InstanceFamily":{ "shape":"GenericString", "documentation":"

The instance family of the recommended Savings Plan.

" }, "Region":{ "shape":"GenericString", "documentation":"

The region the recommendation is generated for.

" }, "OfferingId":{ "shape":"GenericString", "documentation":"

The unique ID that's used to distinguish Savings Plans from one another.

" }, "GenerationTimestamp":{"shape":"ZonedDateTime"}, "LatestUsageTimestamp":{"shape":"ZonedDateTime"}, "CurrentAverageHourlyOnDemandSpend":{ "shape":"GenericString", "documentation":"

The average value of hourly On-Demand spend over the lookback period of the applicable usage type.

" }, "CurrentMaximumHourlyOnDemandSpend":{ "shape":"GenericString", "documentation":"

The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" }, "CurrentMinimumHourlyOnDemandSpend":{ "shape":"GenericString", "documentation":"

The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" }, "EstimatedAverageUtilization":{ "shape":"GenericString", "documentation":"

The estimated utilization of the recommended Savings Plan.

" }, "EstimatedMonthlySavingsAmount":{ "shape":"GenericString", "documentation":"

The estimated monthly savings amount based on the recommended Savings Plan.

" }, "EstimatedOnDemandCost":{ "shape":"GenericString", "documentation":"

The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.

" }, "EstimatedOnDemandCostWithCurrentCommitment":{ "shape":"GenericString", "documentation":"

The estimated On-Demand costs you expect with no additional commitment, based on your usage of the selected time period and the Savings Plan you own.

" }, "EstimatedROI":{ "shape":"GenericString", "documentation":"

The estimated return on investment that's based on the recommended Savings Plan that you purchased. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.

" }, "EstimatedSPCost":{ "shape":"GenericString", "documentation":"

The cost of the recommended Savings Plan over the length of the lookback period.

" }, "EstimatedSavingsAmount":{ "shape":"GenericString", "documentation":"

The estimated savings amount that's based on the recommended Savings Plan over the length of the lookback period.

" }, "EstimatedSavingsPercentage":{ "shape":"GenericString", "documentation":"

The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.

" }, "ExistingHourlyCommitment":{ "shape":"GenericString", "documentation":"

The existing hourly commitment for the Savings Plan type.

" }, "HourlyCommitmentToPurchase":{ "shape":"GenericString", "documentation":"

The recommended hourly commitment level for the Savings Plan type and the configuration that's based on the usage during the lookback period.

" }, "UpfrontCost":{ "shape":"GenericString", "documentation":"

The upfront cost of the recommended Savings Plan, based on the selected payment option.

" }, "CurrentAverageCoverage":{ "shape":"GenericString", "documentation":"

The average value of hourly coverage over the lookback period.

" }, "EstimatedAverageCoverage":{ "shape":"GenericString", "documentation":"

The estimated coverage of the recommended Savings Plan.

" }, "MetricsOverLookbackPeriod":{ "shape":"MetricsOverLookbackPeriod", "documentation":"

The related hourly cost, coverage, and utilization metrics over the lookback period.

" } }, "documentation":"

The details and metrics for the given recommendation.

" }, "RecommendationDetailHourlyMetrics":{ "type":"structure", "members":{ "StartTime":{"shape":"ZonedDateTime"}, "EstimatedOnDemandCost":{ "shape":"GenericString", "documentation":"

The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.

" }, "CurrentCoverage":{ "shape":"GenericString", "documentation":"

The current amount of Savings Plans eligible usage that the Savings Plan covered.

" }, "EstimatedCoverage":{ "shape":"GenericString", "documentation":"

The estimated coverage amount based on the recommended Savings Plan.

" }, "EstimatedNewCommitmentUtilization":{ "shape":"GenericString", "documentation":"

The estimated utilization for the recommended Savings Plan.

" } }, "documentation":"

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

" }, "RecommendationDetailId":{ "type":"string", "max":36, "min":36, "pattern":"^[\\S\\s]{8}-[\\S\\s]{4}-[\\S\\s]{4}-[\\S\\s]{4}-[\\S\\s]{12}$" }, "RecommendationId":{ "type":"string", "max":36, "min":36, "pattern":"^[\\S\\s]{8}-[\\S\\s]{4}-[\\S\\s]{4}-[\\S\\s]{4}-[\\S\\s]{12}$" }, "RecommendationIdList":{ "type":"list", "member":{"shape":"RecommendationId"} }, "RecommendationTarget":{ "type":"string", "enum":[ "SAME_INSTANCE_FAMILY", "CROSS_INSTANCE_FAMILY" ] }, "RedshiftInstanceDetails":{ "type":"structure", "members":{ "Family":{ "shape":"GenericString", "documentation":"

The instance family of the recommended reservation.

" }, "NodeType":{ "shape":"GenericString", "documentation":"

The type of node that Amazon Web Services recommends.

" }, "Region":{ "shape":"GenericString", "documentation":"

The Amazon Web Services Region of the recommended reservation.

" }, "CurrentGeneration":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommendation is for a current-generation instance.

" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"

Determines whether the recommended reservation is size flexible.

" } }, "documentation":"

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

" }, "RequestChangedException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

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

", "exception":true }, "ReservationAggregates":{ "type":"structure", "members":{ "UtilizationPercentage":{ "shape":"UtilizationPercentage", "documentation":"

The percentage of reservation time that you used.

" }, "UtilizationPercentageInUnits":{ "shape":"UtilizationPercentageInUnits", "documentation":"

The percentage of Amazon EC2 reservation time that you used. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" }, "PurchasedHours":{ "shape":"PurchasedHours", "documentation":"

How many reservation hours that you purchased.

" }, "PurchasedUnits":{ "shape":"PurchasedUnits", "documentation":"

The number of Amazon EC2 reservation hours that you purchased. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" }, "TotalActualHours":{ "shape":"TotalActualHours", "documentation":"

The total number of reservation hours that you used.

" }, "TotalActualUnits":{ "shape":"TotalActualUnits", "documentation":"

The total number of Amazon EC2 reservation hours that you used. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" }, "UnusedHours":{ "shape":"UnusedHours", "documentation":"

The number of reservation hours that you didn't use.

" }, "UnusedUnits":{ "shape":"UnusedUnits", "documentation":"

The number of Amazon EC2 reservation hours that you didn't use. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" }, "OnDemandCostOfRIHoursUsed":{ "shape":"OnDemandCostOfRIHoursUsed", "documentation":"

How much your reservation costs if charged On-Demand rates.

" }, "NetRISavings":{ "shape":"NetRISavings", "documentation":"

How much you saved due to purchasing and utilizing reservation. Amazon Web Services calculates this by subtracting `TotalAmortizedFee` from `OnDemandCostOfRIHoursUsed`.

" }, "TotalPotentialRISavings":{ "shape":"TotalPotentialRISavings", "documentation":"

How much you might save if you use your entire reservation.

" }, "AmortizedUpfrontFee":{ "shape":"AmortizedUpfrontFee", "documentation":"

The upfront cost of your reservation. It's amortized over the reservation period.

" }, "AmortizedRecurringFee":{ "shape":"AmortizedRecurringFee", "documentation":"

The monthly cost of your reservation. It's amortized over the reservation period.

" }, "TotalAmortizedFee":{ "shape":"TotalAmortizedFee", "documentation":"

The total cost of your reservation. It's amortized over the reservation period.

" }, "RICostForUnusedHours":{ "shape":"RICostForUnusedHours", "documentation":"

The cost of unused hours for your reservation.

" }, "RealizedSavings":{ "shape":"RealizedSavings", "documentation":"

The realized savings because of purchasing and using a reservation.

" }, "UnrealizedSavings":{ "shape":"UnrealizedSavings", "documentation":"

The unrealized savings because of purchasing and using a reservation.

" } }, "documentation":"

The aggregated numbers for your reservation usage.

" }, "ReservationCoverageGroup":{ "type":"structure", "members":{ "Attributes":{ "shape":"Attributes", "documentation":"

The attributes for this group of reservations.

" }, "Coverage":{ "shape":"Coverage", "documentation":"

How much instance usage this group of reservations covered.

" } }, "documentation":"

A group of reservations that share a set of attributes.

" }, "ReservationCoverageGroups":{ "type":"list", "member":{"shape":"ReservationCoverageGroup"} }, "ReservationGroupKey":{"type":"string"}, "ReservationGroupValue":{"type":"string"}, "ReservationPurchaseRecommendation":{ "type":"structure", "members":{ "AccountScope":{ "shape":"AccountScope", "documentation":"

The account scope that Amazon Web Services recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in Amazon Web Services Organizations.

" }, "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", "documentation":"

How many days of previous usage that Amazon Web Services considers when making this recommendation.

" }, "TermInYears":{ "shape":"TermInYears", "documentation":"

The term of the reservation that you want recommendations for, in years.

" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The payment option for the reservation (for example, `AllUpfront` or `NoUpfront`).

" }, "ServiceSpecification":{ "shape":"ServiceSpecification", "documentation":"

Hardware specifications for the service that you want recommendations for.

" }, "RecommendationDetails":{ "shape":"ReservationPurchaseRecommendationDetails", "documentation":"

Details about the recommended purchases.

" }, "RecommendationSummary":{ "shape":"ReservationPurchaseRecommendationSummary", "documentation":"

A summary about the recommended purchase.

" } }, "documentation":"

A specific reservation that Amazon Web Services recommends for purchase.

" }, "ReservationPurchaseRecommendationDetail":{ "type":"structure", "members":{ "AccountId":{ "shape":"GenericString", "documentation":"

The account that this Reserved Instance (RI) recommendation is for.

" }, "InstanceDetails":{ "shape":"InstanceDetails", "documentation":"

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

" }, "RecommendedNumberOfInstancesToPurchase":{ "shape":"GenericString", "documentation":"

The number of instances that Amazon Web Services recommends that you purchase.

" }, "RecommendedNormalizedUnitsToPurchase":{ "shape":"GenericString", "documentation":"

The number of normalized units that Amazon Web Services recommends that you purchase.

" }, "MinimumNumberOfInstancesUsedPerHour":{ "shape":"GenericString", "documentation":"

The minimum number of instances that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

" }, "MinimumNormalizedUnitsUsedPerHour":{ "shape":"GenericString", "documentation":"

The minimum number of normalized units that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

" }, "MaximumNumberOfInstancesUsedPerHour":{ "shape":"GenericString", "documentation":"

The maximum number of instances that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

" }, "MaximumNormalizedUnitsUsedPerHour":{ "shape":"GenericString", "documentation":"

The maximum number of normalized units that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

" }, "AverageNumberOfInstancesUsedPerHour":{ "shape":"GenericString", "documentation":"

The average number of instances that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

" }, "AverageNormalizedUnitsUsedPerHour":{ "shape":"GenericString", "documentation":"

The average number of normalized units that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

" }, "AverageUtilization":{ "shape":"GenericString", "documentation":"

The average utilization of your instances. Amazon Web Services uses this to calculate your recommended reservation purchases.

" }, "EstimatedBreakEvenInMonths":{ "shape":"GenericString", "documentation":"

How long Amazon Web Services estimates that it takes for this instance to start saving you money, in months.

" }, "CurrencyCode":{ "shape":"GenericString", "documentation":"

The currency code that Amazon Web Services used to calculate the costs for this instance.

" }, "EstimatedMonthlySavingsAmount":{ "shape":"GenericString", "documentation":"

How much Amazon Web Services estimates that this specific recommendation might save you in a month.

" }, "EstimatedMonthlySavingsPercentage":{ "shape":"GenericString", "documentation":"

How much Amazon Web Services estimates that this specific recommendation might save you in a month, as a percentage of your overall costs.

" }, "EstimatedMonthlyOnDemandCost":{ "shape":"GenericString", "documentation":"

How much Amazon Web Services estimates that you spend on On-Demand Instances in a month.

" }, "EstimatedReservationCostForLookbackPeriod":{ "shape":"GenericString", "documentation":"

How much Amazon Web Services estimates that you might spend for all usage during the specified historical period if you had a reservation.

" }, "UpfrontCost":{ "shape":"GenericString", "documentation":"

How much purchasing this instance costs you upfront.

" }, "RecurringStandardMonthlyCost":{ "shape":"GenericString", "documentation":"

How much purchasing this instance costs you on a monthly basis.

" } }, "documentation":"

Details about your recommended reservation purchase.

" }, "ReservationPurchaseRecommendationDetails":{ "type":"list", "member":{"shape":"ReservationPurchaseRecommendationDetail"} }, "ReservationPurchaseRecommendationMetadata":{ "type":"structure", "members":{ "RecommendationId":{ "shape":"GenericString", "documentation":"

The ID for this specific recommendation.

" }, "GenerationTimestamp":{ "shape":"GenericString", "documentation":"

The timestamp for when Amazon Web Services made this recommendation.

" } }, "documentation":"

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

" }, "ReservationPurchaseRecommendationSummary":{ "type":"structure", "members":{ "TotalEstimatedMonthlySavingsAmount":{ "shape":"GenericString", "documentation":"

The total amount that Amazon Web Services estimates that this recommendation could save you in a month.

" }, "TotalEstimatedMonthlySavingsPercentage":{ "shape":"GenericString", "documentation":"

The total amount that Amazon Web Services estimates that this recommendation could save you in a month, as a percentage of your costs.

" }, "CurrencyCode":{ "shape":"GenericString", "documentation":"

The currency code used for this recommendation.

" } }, "documentation":"

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.

" }, "ReservationPurchaseRecommendations":{ "type":"list", "member":{"shape":"ReservationPurchaseRecommendation"} }, "ReservationUtilizationGroup":{ "type":"structure", "members":{ "Key":{ "shape":"ReservationGroupKey", "documentation":"

The key for a specific reservation attribute.

" }, "Value":{ "shape":"ReservationGroupValue", "documentation":"

The value of a specific reservation attribute.

" }, "Attributes":{ "shape":"Attributes", "documentation":"

The attributes for this group of reservations.

" }, "Utilization":{ "shape":"ReservationAggregates", "documentation":"

How much you used this group of reservations.

" } }, "documentation":"

A group of reservations that share a set of attributes.

" }, "ReservationUtilizationGroups":{ "type":"list", "member":{"shape":"ReservationUtilizationGroup"} }, "ReservedHours":{"type":"string"}, "ReservedNormalizedUnits":{"type":"string"}, "ResourceDetails":{ "type":"structure", "members":{ "EC2ResourceDetails":{ "shape":"EC2ResourceDetails", "documentation":"

Details for the Amazon EC2 resource.

" } }, "documentation":"

Details for the resource.

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"}, "ResourceName":{"shape":"Arn"} }, "documentation":"

The specified ARN in the request doesn't exist.

", "exception":true }, "ResourceTag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"ResourceTagKey", "documentation":"

The key that's associated with the tag.

" }, "Value":{ "shape":"ResourceTagValue", "documentation":"

The value that's associated with the tag.

" } }, "documentation":"

The tag structure that contains a tag key and value.

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

" }, "ResourceTagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "ResourceTagKeyList":{ "type":"list", "member":{"shape":"ResourceTagKey"}, "max":200, "min":0 }, "ResourceTagList":{ "type":"list", "member":{"shape":"ResourceTag"}, "max":200, "min":0 }, "ResourceTagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "ResourceUtilization":{ "type":"structure", "members":{ "EC2ResourceUtilization":{ "shape":"EC2ResourceUtilization", "documentation":"

The utilization of current Amazon EC2 instance.

" } }, "documentation":"

Resource utilization of current resource.

" }, "ResultByTime":{ "type":"structure", "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

The time period that the result covers.

" }, "Total":{ "shape":"Metrics", "documentation":"

The total amount of cost or usage accrued during the time period.

" }, "Groups":{ "shape":"Groups", "documentation":"

The groups that this time period includes.

" }, "Estimated":{ "shape":"Estimated", "documentation":"

Determines whether the result is estimated.

" } }, "documentation":"

The result that's associated with a time period.

" }, "ResultsByTime":{ "type":"list", "member":{"shape":"ResultByTime"} }, "RightsizingRecommendation":{ "type":"structure", "members":{ "AccountId":{ "shape":"GenericString", "documentation":"

The account that this recommendation is for.

" }, "CurrentInstance":{ "shape":"CurrentInstance", "documentation":"

Context regarding the current instance.

" }, "RightsizingType":{ "shape":"RightsizingType", "documentation":"

A recommendation to either terminate or modify the resource.

" }, "ModifyRecommendationDetail":{ "shape":"ModifyRecommendationDetail", "documentation":"

The details for the modification recommendations.

" }, "TerminateRecommendationDetail":{ "shape":"TerminateRecommendationDetail", "documentation":"

The details for termination recommendations.

" }, "FindingReasonCodes":{ "shape":"FindingReasonCodes", "documentation":"

The list of possible reasons why the recommendation is generated, such as under- or over-utilization of specific metrics (for example, CPU, Memory, Network).

" } }, "documentation":"

Recommendations to rightsize resources.

" }, "RightsizingRecommendationConfiguration":{ "type":"structure", "required":[ "RecommendationTarget", "BenefitsConsidered" ], "members":{ "RecommendationTarget":{ "shape":"RecommendationTarget", "documentation":"

The option to see recommendations within the same instance family or recommendations for instances across other families. The default value is `SAME_INSTANCE_FAMILY`.

" }, "BenefitsConsidered":{ "shape":"GenericBoolean", "documentation":"

The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is `TRUE`.

" } }, "documentation":"

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.

" }, "RightsizingRecommendationList":{ "type":"list", "member":{"shape":"RightsizingRecommendation"} }, "RightsizingRecommendationMetadata":{ "type":"structure", "members":{ "RecommendationId":{ "shape":"GenericString", "documentation":"

The ID for this specific recommendation.

" }, "GenerationTimestamp":{ "shape":"GenericString", "documentation":"

The timestamp for when Amazon Web Services made this recommendation.

" }, "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", "documentation":"

The number of days of previous usage that Amazon Web Services considers when making this recommendation.

" }, "AdditionalMetadata":{ "shape":"GenericString", "documentation":"

Additional metadata that might be applicable to the recommendation.

" } }, "documentation":"

Metadata for this recommendation set.

" }, "RightsizingRecommendationSummary":{ "type":"structure", "members":{ "TotalRecommendationCount":{ "shape":"GenericString", "documentation":"

The total number of instance recommendations.

" }, "EstimatedTotalMonthlySavingsAmount":{ "shape":"GenericString", "documentation":"

The estimated total savings resulting from modifications, on a monthly basis.

" }, "SavingsCurrencyCode":{ "shape":"GenericString", "documentation":"

The currency code that Amazon Web Services used to calculate the savings.

" }, "SavingsPercentage":{ "shape":"GenericString", "documentation":"

The savings percentage based on the recommended modifications. It's relative to the total On-Demand costs that are associated with these instances.

" } }, "documentation":"

The summary of rightsizing recommendations

" }, "RightsizingType":{ "type":"string", "enum":[ "TERMINATE", "MODIFY" ] }, "RootCause":{ "type":"structure", "members":{ "Service":{ "shape":"GenericString", "documentation":"

The Amazon Web Service name that's associated with the cost anomaly.

" }, "Region":{ "shape":"GenericString", "documentation":"

The Amazon Web Services Region that's associated with the cost anomaly.

" }, "LinkedAccount":{ "shape":"GenericString", "documentation":"

The member account value that's associated with the cost anomaly.

" }, "UsageType":{ "shape":"GenericString", "documentation":"

The `UsageType` value that's associated with the cost anomaly.

" }, "LinkedAccountName":{ "shape":"GenericString", "documentation":"

The member account name value that's associated with the cost anomaly.

" } }, "documentation":"

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.

" }, "RootCauses":{ "type":"list", "member":{"shape":"RootCause"} }, "SavingsPlanArn":{"type":"string"}, "SavingsPlansAmortizedCommitment":{ "type":"structure", "members":{ "AmortizedRecurringCommitment":{ "shape":"GenericString", "documentation":"

The amortized amount of your Savings Plans commitment that was purchased with either a `Partial` or a `NoUpfront`.

" }, "AmortizedUpfrontCommitment":{ "shape":"GenericString", "documentation":"

The amortized amount of your Savings Plans commitment that was purchased with an `Upfront` or `PartialUpfront` Savings Plans.

" }, "TotalAmortizedCommitment":{ "shape":"GenericString", "documentation":"

The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.

" } }, "documentation":"

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

" }, "SavingsPlansCoverage":{ "type":"structure", "members":{ "Attributes":{ "shape":"Attributes", "documentation":"

The attribute that applies to a specific `Dimension`.

" }, "Coverage":{ "shape":"SavingsPlansCoverageData", "documentation":"

The amount of Savings Plans eligible usage that the Savings Plans covered.

" }, "TimePeriod":{"shape":"DateInterval"} }, "documentation":"

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.

" }, "SavingsPlansCoverageData":{ "type":"structure", "members":{ "SpendCoveredBySavingsPlans":{ "shape":"GenericString", "documentation":"

The amount of your Amazon Web Services usage that's covered by a Savings Plans.

" }, "OnDemandCost":{ "shape":"GenericString", "documentation":"

The cost of your Amazon Web Services usage at the public On-Demand rate.

" }, "TotalCost":{ "shape":"GenericString", "documentation":"

The total cost of your Amazon Web Services usage, regardless of your purchase option.

" }, "CoveragePercentage":{ "shape":"GenericString", "documentation":"

The percentage of your existing Savings Plans covered usage, divided by all of your eligible Savings Plans usage in an account (or set of accounts).

" } }, "documentation":"

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

" }, "SavingsPlansCoverages":{ "type":"list", "member":{"shape":"SavingsPlansCoverage"} }, "SavingsPlansDataType":{ "type":"string", "enum":[ "ATTRIBUTES", "UTILIZATION", "AMORTIZED_COMMITMENT", "SAVINGS" ] }, "SavingsPlansDataTypes":{ "type":"list", "member":{"shape":"SavingsPlansDataType"} }, "SavingsPlansDetails":{ "type":"structure", "members":{ "Region":{ "shape":"GenericString", "documentation":"

A collection of Amazon Web Services resources in a geographic area. Each Amazon Web Services Region is isolated and independent of the other Regions.

" }, "InstanceFamily":{ "shape":"GenericString", "documentation":"

A group of instance types that Savings Plans applies to.

" }, "OfferingId":{ "shape":"GenericString", "documentation":"

The unique ID that's used to distinguish Savings Plans from one another.

" } }, "documentation":"

The attribute details on a specific Savings Plan.

" }, "SavingsPlansPurchaseRecommendation":{ "type":"structure", "members":{ "AccountScope":{ "shape":"AccountScope", "documentation":"

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations that include the management account and member accounts if the value is set to `PAYER`. If the value is `LINKED`, recommendations are calculated for individual member accounts only.

" }, "SavingsPlansType":{ "shape":"SupportedSavingsPlansType", "documentation":"

The requested Savings Plans recommendation type.

" }, "TermInYears":{ "shape":"TermInYears", "documentation":"

The Savings Plans recommendation term in years. It's used to generate the recommendation.

" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The payment option that's used to generate the recommendation.

" }, "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", "documentation":"

The lookback period in days that's used to generate the recommendation.

" }, "SavingsPlansPurchaseRecommendationDetails":{ "shape":"SavingsPlansPurchaseRecommendationDetailList", "documentation":"

Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible workloads.

" }, "SavingsPlansPurchaseRecommendationSummary":{ "shape":"SavingsPlansPurchaseRecommendationSummary", "documentation":"

Summary metrics for your Savings Plans Recommendations.

" } }, "documentation":"

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

" }, "SavingsPlansPurchaseRecommendationDetail":{ "type":"structure", "members":{ "SavingsPlansDetails":{ "shape":"SavingsPlansDetails", "documentation":"

Details for your recommended Savings Plans.

" }, "AccountId":{ "shape":"GenericString", "documentation":"

The `AccountID` the recommendation is generated for.

" }, "UpfrontCost":{ "shape":"GenericString", "documentation":"

The upfront cost of the recommended Savings Plans, based on the selected payment option.

" }, "EstimatedROI":{ "shape":"GenericString", "documentation":"

The estimated return on investment that's based on the recommended Savings Plans that you purchased. This is calculated as `estimatedSavingsAmount`/ `estimatedSPCost`*100.

" }, "CurrencyCode":{ "shape":"GenericString", "documentation":"

The currency code that Amazon Web Services used to generate the recommendations and present potential savings.

" }, "EstimatedSPCost":{ "shape":"GenericString", "documentation":"

The cost of the recommended Savings Plans over the length of the lookback period.

" }, "EstimatedOnDemandCost":{ "shape":"GenericString", "documentation":"

The remaining On-Demand cost estimated to not be covered by the recommended Savings Plans, over the length of the lookback period.

" }, "EstimatedOnDemandCostWithCurrentCommitment":{ "shape":"GenericString", "documentation":"

The estimated On-Demand costs you expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own.

" }, "EstimatedSavingsAmount":{ "shape":"GenericString", "documentation":"

The estimated savings amount that's based on the recommended Savings Plans over the length of the lookback period.

" }, "EstimatedSavingsPercentage":{ "shape":"GenericString", "documentation":"

The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.

" }, "HourlyCommitmentToPurchase":{ "shape":"GenericString", "documentation":"

The recommended hourly commitment level for the Savings Plans type and the configuration that's based on the usage during the lookback period.

" }, "EstimatedAverageUtilization":{ "shape":"GenericString", "documentation":"

The estimated utilization of the recommended Savings Plans.

" }, "EstimatedMonthlySavingsAmount":{ "shape":"GenericString", "documentation":"

The estimated monthly savings amount based on the recommended Savings Plans.

" }, "CurrentMinimumHourlyOnDemandSpend":{ "shape":"GenericString", "documentation":"

The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" }, "CurrentMaximumHourlyOnDemandSpend":{ "shape":"GenericString", "documentation":"

The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" }, "CurrentAverageHourlyOnDemandSpend":{ "shape":"GenericString", "documentation":"

The average value of hourly On-Demand spend over the lookback period of the applicable usage type.

" }, "RecommendationDetailId":{ "shape":"RecommendationDetailId", "documentation":"

Contains detailed information about a specific Savings Plan recommendation.

" } }, "documentation":"

Details for your recommended Savings Plans.

" }, "SavingsPlansPurchaseRecommendationDetailList":{ "type":"list", "member":{"shape":"SavingsPlansPurchaseRecommendationDetail"} }, "SavingsPlansPurchaseRecommendationMetadata":{ "type":"structure", "members":{ "RecommendationId":{ "shape":"GenericString", "documentation":"

The unique identifier for the recommendation set.

" }, "GenerationTimestamp":{ "shape":"GenericString", "documentation":"

The timestamp that shows when the recommendations were generated.

" }, "AdditionalMetadata":{ "shape":"GenericString", "documentation":"

Additional metadata that might be applicable to the recommendation.

" } }, "documentation":"

Metadata about your Savings Plans Purchase Recommendations.

" }, "SavingsPlansPurchaseRecommendationSummary":{ "type":"structure", "members":{ "EstimatedROI":{ "shape":"GenericString", "documentation":"

The estimated return on investment that's based on the recommended Savings Plans and estimated savings.

" }, "CurrencyCode":{ "shape":"GenericString", "documentation":"

The currency code that Amazon Web Services used to generate the recommendations and present potential savings.

" }, "EstimatedTotalCost":{ "shape":"GenericString", "documentation":"

The estimated total cost of the usage after purchasing the recommended Savings Plans. This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand usage.

" }, "CurrentOnDemandSpend":{ "shape":"GenericString", "documentation":"

The current total on demand spend of the applicable usage types over the lookback period.

" }, "EstimatedSavingsAmount":{ "shape":"GenericString", "documentation":"

The estimated total savings over the lookback period, based on the purchase of the recommended Savings Plans.

" }, "TotalRecommendationCount":{ "shape":"GenericString", "documentation":"

The aggregate number of Savings Plans recommendations that exist for your account.

" }, "DailyCommitmentToPurchase":{ "shape":"GenericString", "documentation":"

The recommended Savings Plans cost on a daily (24 hourly) basis.

" }, "HourlyCommitmentToPurchase":{ "shape":"GenericString", "documentation":"

The recommended hourly commitment that's based on the recommendation parameters.

" }, "EstimatedSavingsPercentage":{ "shape":"GenericString", "documentation":"

The estimated savings relative to the total cost of On-Demand usage, over the lookback period. This is calculated as `estimatedSavingsAmount`/ `CurrentOnDemandSpend`*100.

" }, "EstimatedMonthlySavingsAmount":{ "shape":"GenericString", "documentation":"

The estimated monthly savings amount that's based on the recommended Savings Plans purchase.

" }, "EstimatedOnDemandCostWithCurrentCommitment":{ "shape":"GenericString", "documentation":"

The estimated On-Demand costs you expect with no additional commitment. It's based on your usage of the selected time period and the Savings Plans you own.

" } }, "documentation":"

Summary metrics for your Savings Plans Purchase Recommendations.

" }, "SavingsPlansSavings":{ "type":"structure", "members":{ "NetSavings":{ "shape":"GenericString", "documentation":"

The savings amount that you're accumulating for the usage that's covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.

" }, "OnDemandCostEquivalent":{ "shape":"GenericString", "documentation":"

How much the amount that the usage would have cost if it was accrued at the On-Demand rate.

" } }, "documentation":"

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

" }, "SavingsPlansUtilization":{ "type":"structure", "members":{ "TotalCommitment":{ "shape":"GenericString", "documentation":"

The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).

" }, "UsedCommitment":{ "shape":"GenericString", "documentation":"

The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.

" }, "UnusedCommitment":{ "shape":"GenericString", "documentation":"

The amount of your Savings Plans commitment that wasn't consumed from Savings Plans eligible usage in a specific period.

" }, "UtilizationPercentage":{ "shape":"GenericString", "documentation":"

The amount of `UsedCommitment` divided by the `TotalCommitment` for your Savings Plans.

" } }, "documentation":"

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

" }, "SavingsPlansUtilizationAggregates":{ "type":"structure", "required":["Utilization"], "members":{ "Utilization":{ "shape":"SavingsPlansUtilization", "documentation":"

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

" }, "Savings":{ "shape":"SavingsPlansSavings", "documentation":"

The amount that's saved by using existing Savings Plans. Savings returns both net savings from Savings Plans and also the `onDemandCostEquivalent` of the Savings Plans when considering the utilization rate.

" }, "AmortizedCommitment":{ "shape":"SavingsPlansAmortizedCommitment", "documentation":"

The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

" } }, "documentation":"

The aggregated utilization metrics for your Savings Plans usage.

" }, "SavingsPlansUtilizationByTime":{ "type":"structure", "required":[ "TimePeriod", "Utilization" ], "members":{ "TimePeriod":{"shape":"DateInterval"}, "Utilization":{ "shape":"SavingsPlansUtilization", "documentation":"

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

" }, "Savings":{ "shape":"SavingsPlansSavings", "documentation":"

The amount that's saved by using existing Savings Plans. Savings returns both net savings from Savings Plans and also the `onDemandCostEquivalent` of the Savings Plans when considering the utilization rate.

" }, "AmortizedCommitment":{ "shape":"SavingsPlansAmortizedCommitment", "documentation":"

The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

" } }, "documentation":"

The amount of Savings Plans utilization (in hours).

" }, "SavingsPlansUtilizationDetail":{ "type":"structure", "members":{ "SavingsPlanArn":{ "shape":"SavingsPlanArn", "documentation":"

The unique Amazon Resource Name (ARN) for a particular Savings Plan.

" }, "Attributes":{ "shape":"Attributes", "documentation":"

The attribute that applies to a specific `Dimension`.

" }, "Utilization":{ "shape":"SavingsPlansUtilization", "documentation":"

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

" }, "Savings":{ "shape":"SavingsPlansSavings", "documentation":"

The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans and also the `onDemandCostEquivalent` of the Savings Plans when considering the utilization rate.

" }, "AmortizedCommitment":{ "shape":"SavingsPlansAmortizedCommitment", "documentation":"

The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings Plans fees.

" } }, "documentation":"

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.

" }, "SavingsPlansUtilizationDetails":{ "type":"list", "member":{"shape":"SavingsPlansUtilizationDetail"} }, "SavingsPlansUtilizationsByTime":{ "type":"list", "member":{"shape":"SavingsPlansUtilizationByTime"} }, "SearchString":{ "type":"string", "max":1024, "min":0, "pattern":"[\\S\\s]*" }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

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

", "exception":true }, "ServiceSpecification":{ "type":"structure", "members":{ "EC2Specification":{ "shape":"EC2Specification", "documentation":"

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

" } }, "documentation":"

Hardware specifications for the service that you want recommendations for.

" }, "SortDefinition":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"SortDefinitionKey", "documentation":"

The key that's used to sort the data.

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

The order that's used to sort the data.

" } }, "documentation":"

The details for how to sort the data.

" }, "SortDefinitionKey":{ "type":"string", "max":1024, "min":0, "pattern":"[\\S\\s]*" }, "SortDefinitions":{ "type":"list", "member":{"shape":"SortDefinition"} }, "SortOrder":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "StartSavingsPlansPurchaseRecommendationGenerationRequest":{ "type":"structure", "members":{ } }, "StartSavingsPlansPurchaseRecommendationGenerationResponse":{ "type":"structure", "members":{ "RecommendationId":{ "shape":"RecommendationId", "documentation":"

The ID for this specific recommendation.

" }, "GenerationStartedTime":{ "shape":"ZonedDateTime", "documentation":"

The start time of the recommendation generation.

" }, "EstimatedCompletionTime":{ "shape":"ZonedDateTime", "documentation":"

The estimated time for when the recommendation generation will complete.

" } } }, "Subscriber":{ "type":"structure", "members":{ "Address":{ "shape":"SubscriberAddress", "documentation":"

The email address or SNS Amazon Resource Name (ARN). This depends on the `Type`.

" }, "Type":{ "shape":"SubscriberType", "documentation":"

The notification delivery channel.

" }, "Status":{ "shape":"SubscriberStatus", "documentation":"

Indicates if the subscriber accepts the notifications.

" } }, "documentation":"

The recipient of `AnomalySubscription` notifications.

" }, "SubscriberAddress":{ "type":"string", "max":302, "min":6, "pattern":"(^[a-zA-Z0-9.!#$%&'*+=?^_‘{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+(\\.fifo)?$)" }, "SubscriberStatus":{ "type":"string", "enum":[ "CONFIRMED", "DECLINED" ] }, "SubscriberType":{ "type":"string", "enum":[ "EMAIL", "SNS" ] }, "Subscribers":{ "type":"list", "member":{"shape":"Subscriber"} }, "SupportedSavingsPlansType":{ "type":"string", "enum":[ "COMPUTE_SP", "EC2_INSTANCE_SP", "SAGEMAKER_SP" ] }, "TagKey":{ "type":"string", "max":1024, "min":0, "pattern":"[\\S\\s]*" }, "TagList":{ "type":"list", "member":{"shape":"Entity"} }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "ResourceTags" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag.

" }, "ResourceTags":{ "shape":"ResourceTagList", "documentation":"

A list of tag key-value pairs to be added to the resource.

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

- Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

- The maximum length of a key is 128 characters

- The maximum length of a value is 256 characters

- Keys and values can only contain alphanumeric characters, spaces, and any of the following: `_.:/=+@-`

- Keys and values are case sensitive

- Keys and values are trimmed for any leading or trailing whitespaces

- Don’t use `aws:` as a prefix for your keys. This prefix is reserved for Amazon Web Services use

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValues":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key for the tag.

" }, "Values":{ "shape":"Values", "documentation":"

The specific value of the tag.

" }, "MatchOptions":{ "shape":"MatchOptions", "documentation":"

The match options that you can use to filter your results. `MatchOptions` is only applicable for actions related to Cost Category. The default values for `MatchOptions` are `EQUALS` and `CASE_SENSITIVE`.

" } }, "documentation":"

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.

" }, "TagValuesList":{ "type":"list", "member":{"shape":"TagValues"} }, "TargetInstance":{ "type":"structure", "members":{ "EstimatedMonthlyCost":{ "shape":"GenericString", "documentation":"

The expected cost to operate this instance type on a monthly basis.

" }, "EstimatedMonthlySavings":{ "shape":"GenericString", "documentation":"

The estimated savings that result from modification, on a monthly basis.

" }, "CurrencyCode":{ "shape":"GenericString", "documentation":"

The currency code that Amazon Web Services used to calculate the costs for this instance.

" }, "DefaultTargetInstance":{ "shape":"GenericBoolean", "documentation":"

Determines whether this recommendation is the defaulted Amazon Web Services recommendation.

" }, "ResourceDetails":{ "shape":"ResourceDetails", "documentation":"

Details on the target instance type.

" }, "ExpectedResourceUtilization":{ "shape":"ResourceUtilization", "documentation":"

The expected utilization metrics for target instance type.

" }, "PlatformDifferences":{ "shape":"PlatformDifferences", "documentation":"

Explains the actions that you might need to take to successfully migrate your workloads from the current instance type to the recommended instance type.

" } }, "documentation":"

Details on recommended instance.

" }, "TargetInstancesList":{ "type":"list", "member":{"shape":"TargetInstance"} }, "TermInYears":{ "type":"string", "enum":[ "ONE_YEAR", "THREE_YEARS" ] }, "TerminateRecommendationDetail":{ "type":"structure", "members":{ "EstimatedMonthlySavings":{ "shape":"GenericString", "documentation":"

The estimated savings that result from modification, on a monthly basis.

" }, "CurrencyCode":{ "shape":"GenericString", "documentation":"

The currency code that Amazon Web Services used to calculate the costs for this instance.

" } }, "documentation":"

Details on termination recommendation.

" }, "TooManyTagsException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"}, "ResourceName":{"shape":"Arn"} }, "documentation":"

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

", "exception":true }, "TotalActualHours":{"type":"string"}, "TotalActualUnits":{"type":"string"}, "TotalAmortizedFee":{"type":"string"}, "TotalImpactFilter":{ "type":"structure", "required":[ "NumericOperator", "StartValue" ], "members":{ "NumericOperator":{ "shape":"NumericOperator", "documentation":"

The comparing value that's used in the filter.

" }, "StartValue":{ "shape":"GenericDouble", "documentation":"

The lower bound dollar value that's used in the filter.

" }, "EndValue":{ "shape":"GenericDouble", "documentation":"

The upper bound dollar value that's used in the filter.

" } }, "documentation":"

Filters cost anomalies based on the total impact.

" }, "TotalPotentialRISavings":{"type":"string"}, "TotalRunningHours":{"type":"string"}, "TotalRunningNormalizedUnits":{"type":"string"}, "UnknownMonitorException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The cost anomaly monitor does not exist for the account.

", "exception":true }, "UnknownSubscriptionException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The cost anomaly subscription does not exist for the account.

", "exception":true }, "UnrealizedSavings":{"type":"string"}, "UnresolvableUsageUnitException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

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

", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "ResourceTagKeys" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag.

" }, "ResourceTagKeys":{ "shape":"ResourceTagKeyList", "documentation":"

A list of tag keys associated with tags that need to be removed from the resource. If you specify a tag key that doesn't exist, it's ignored. Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UnusedHours":{"type":"string"}, "UnusedUnits":{"type":"string"}, "UpdateAnomalyMonitorRequest":{ "type":"structure", "required":["MonitorArn"], "members":{ "MonitorArn":{ "shape":"GenericString", "documentation":"

Cost anomaly monitor Amazon Resource Names (ARNs).

" }, "MonitorName":{ "shape":"GenericString", "documentation":"

The new name for the cost anomaly monitor.

" } } }, "UpdateAnomalyMonitorResponse":{ "type":"structure", "required":["MonitorArn"], "members":{ "MonitorArn":{ "shape":"GenericString", "documentation":"

A cost anomaly monitor ARN.

" } } }, "UpdateAnomalySubscriptionRequest":{ "type":"structure", "required":["SubscriptionArn"], "members":{ "SubscriptionArn":{ "shape":"GenericString", "documentation":"

A cost anomaly subscription Amazon Resource Name (ARN).

" }, "Threshold":{ "shape":"NullableNonNegativeDouble", "documentation":"

(deprecated)

The update to the threshold value for receiving notifications.

This field has been deprecated. To update a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.

You can specify either Threshold or ThresholdExpression, but not both.

", "deprecated":true, "deprecatedMessage":"Threshold has been deprecated in favor of ThresholdExpression" }, "Frequency":{ "shape":"AnomalySubscriptionFrequency", "documentation":"

The update to the frequency value that subscribers receive notifications.

" }, "MonitorArnList":{ "shape":"MonitorArnList", "documentation":"

A list of cost anomaly monitor ARNs.

" }, "Subscribers":{ "shape":"Subscribers", "documentation":"

The update to the subscriber list.

" }, "SubscriptionName":{ "shape":"GenericString", "documentation":"

The new name of the subscription.

" }, "ThresholdExpression":{ "shape":"Expression", "documentation":"

The update to the Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are `ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE`, corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are `AND` and `OR`. The match option `GREATER_THAN_OR_EQUAL` is required. Values must be numbers between 0 and 10,000,000,000 in string format.

You can specify either Threshold or ThresholdExpression, but not both.

The following are examples of valid ThresholdExpressions:

- Absolute threshold: `{ \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }`

- Percentage threshold: `{ \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }`

- `AND` two thresholds together: `{ \"And\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }`

- `OR` two thresholds together: `{ \"Or\": [ { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } } ] }`

" } } }, "UpdateAnomalySubscriptionResponse":{ "type":"structure", "required":["SubscriptionArn"], "members":{ "SubscriptionArn":{ "shape":"GenericString", "documentation":"

A cost anomaly subscription ARN.

" } } }, "UpdateCostAllocationTagsStatusError":{ "type":"structure", "members":{ "TagKey":{ "shape":"TagKey", "documentation":"

The key for the cost allocation tag.

" }, "Code":{ "shape":"GenericString", "documentation":"

An error code representing why the action failed on this entry.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

A message explaining why the action failed on this entry.

" } }, "documentation":"

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

" }, "UpdateCostAllocationTagsStatusErrors":{ "type":"list", "member":{"shape":"UpdateCostAllocationTagsStatusError"}, "max":20, "min":0 }, "UpdateCostAllocationTagsStatusRequest":{ "type":"structure", "required":["CostAllocationTagsStatus"], "members":{ "CostAllocationTagsStatus":{ "shape":"CostAllocationTagStatusList", "documentation":"

The list of `CostAllocationTagStatusEntry` objects that are used to update cost allocation tags status for this request.

" } } }, "UpdateCostAllocationTagsStatusResponse":{ "type":"structure", "members":{ "Errors":{ "shape":"UpdateCostAllocationTagsStatusErrors", "documentation":"

A list of `UpdateCostAllocationTagsStatusError` objects with error details about each cost allocation tag that can't be updated. If there's no failure, an empty array returns.

" } } }, "UpdateCostCategoryDefinitionRequest":{ "type":"structure", "required":[ "CostCategoryArn", "RuleVersion", "Rules" ], "members":{ "CostCategoryArn":{ "shape":"Arn", "documentation":"

The unique identifier for your Cost Category.

" }, "EffectiveStart":{ "shape":"ZonedDateTime", "documentation":"

The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.

" }, "RuleVersion":{"shape":"CostCategoryRuleVersion"}, "Rules":{ "shape":"CostCategoryRulesList", "documentation":"

The `Expression` object used to categorize costs. For more information, see CostCategoryRule .

" }, "DefaultValue":{"shape":"CostCategoryValue"}, "SplitChargeRules":{ "shape":"CostCategorySplitChargeRulesList", "documentation":"

The split charge rules used to allocate your charges between your Cost Category values.

" } } }, "UpdateCostCategoryDefinitionResponse":{ "type":"structure", "members":{ "CostCategoryArn":{ "shape":"Arn", "documentation":"

The unique identifier for your Cost Category.

" }, "EffectiveStart":{ "shape":"ZonedDateTime", "documentation":"

The Cost Category's effective start date. It can only be a billing start date (first day of the month).

" } } }, "UtilizationByTime":{ "type":"structure", "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"

The period of time that this utilization was used for.

" }, "Groups":{ "shape":"ReservationUtilizationGroups", "documentation":"

The groups that this utilization result uses.

" }, "Total":{ "shape":"ReservationAggregates", "documentation":"

The total number of reservation hours that were used.

" } }, "documentation":"

The amount of utilization, in hours.

" }, "UtilizationPercentage":{"type":"string"}, "UtilizationPercentageInUnits":{"type":"string"}, "UtilizationsByTime":{ "type":"list", "member":{"shape":"UtilizationByTime"} }, "Value":{ "type":"string", "max":1024, "min":0, "pattern":"[\\S\\s]*" }, "Values":{ "type":"list", "member":{"shape":"Value"} }, "YearMonthDay":{ "type":"string", "max":40, "min":0, "pattern":"(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?" }, "ZonedDateTime":{ "type":"string", "documentation":"

The period of time that you want the usage and costs for.

", "max":25, "min":20, "pattern":"^\\d{4}-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d(([+-]\\d\\d:\\d\\d)|Z)$" } }, "documentation":"

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.

" }