Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Creates a new Cost Category with the requested name and rules.
" }, "DeleteCostCategoryDefinition":{ "name":"DeleteCostCategoryDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCostCategoryDefinitionRequest"}, "output":{"shape":"DeleteCostCategoryDefinitionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
" }, "DescribeCostCategoryDefinition":{ "name":"DescribeCostCategoryDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCostCategoryDefinitionRequest"}, "output":{"shape":"DescribeCostCategoryDefinitionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.
You have the option to use EffectiveOn to return a Cost Category that is active on a specific date. If there is no EffectiveOn specified, you’ll see a Cost Category that is effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.
Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.
This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.
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. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
To determine valid values for a dimension, use the GetDimensionValues operation.
Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.
For example, AWS automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large because that is the smallest size instance in the c4 instance family.
Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.
Creates recommendations that helps you save cost by identifying idle and underutilized Amazon EC2 instances.
Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations.
" }, "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 master account can see the coverage of the associated member accounts. For any time period, you can filter data for Savings Plans usage with the following dimensions:
LINKED_ACCOUNT
REGION
SERVICE
INSTANCE_FAMILY
To determine valid values for a dimension, use the GetDimensionValues operation.
Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
" }, "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. Master accounts in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.
You cannot group by any dimension values for GetSavingsPlansUtilization.
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.
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.
" }, "ListCostCategoryDefinitions":{ "name":"ListCostCategoryDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCostCategoryDefinitionsRequest"}, "output":{"shape":"ListCostCategoryDefinitionsResponse"}, "errors":[ {"shape":"LimitExceededException"} ], "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Returns the name, ARN and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.
" } }, "shapes":{ "AccountScope":{ "type":"string", "enum":[ "PAYER", "LINKED" ] }, "AmortizedRecurringFee":{"type":"string"}, "AmortizedUpfrontFee":{"type":"string"}, "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" ] }, "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 Cost Category's effective start date.
" }, "EffectiveEnd":{ "shape":"ZonedDateTime", "documentation":"The Cost Category's effective end date.
" }, "Name":{"shape":"CostCategoryName"}, "RuleVersion":{"shape":"CostCategoryRuleVersion"}, "Rules":{ "shape":"CostCategoryRulesList", "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.
" } }, "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
The structure of Cost Categories. This includes detailed metadata and the set of rules for the CostCategory object.
The unique name of the Cost Category.
", "max":255, "min":1, "pattern":"^(?! )[\\p{L}\\p{N}\\p{Z}-_]*(? The unique identifier for your Cost Category Reference. " }, "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.
" } }, "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
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.
An Expression object used to categorize costs. This supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is LINKED_ACCOUNT.
Root level OR is not supported. We recommend you create a separate rule instead.
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
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.
" }, "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 }, "CostCategoryValue":{ "type":"string", "documentation":"The value a line item will be categorized as, if it matches the rule.
", "max":255, "min":1, "pattern":"^(?! )[\\p{L}\\p{N}\\p{Z}-_]*(?The specific value of the Cost Category." } }, "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
The values that are available for Cost Categories.
" }, "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 cost.
" } }, "documentation":"How much it cost 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. Normalized units enable you to see your EC2 usage for multiple sizes of instances in a uniform way. For example, suppose 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. Using 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"} }, "CreateCostCategoryDefinitionRequest":{ "type":"structure", "required":[ "Name", "RuleVersion", "Rules" ], "members":{ "Name":{"shape":"CostCategoryName"}, "RuleVersion":{"shape":"CostCategoryRuleVersion"}, "Rules":{ "shape":"CostCategoryRulesList", "documentation":" CreateCostCategoryDefinition supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is LINKED_ACCOUNT.
Root level OR is not supported. We recommend you create a separate rule instead.
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.
" } } }, "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.
" } } }, "CurrentInstance":{ "type":"structure", "members":{ "ResourceId":{ "shape":"GenericString", "documentation":"Resource ID of the current instance.
" }, "Tags":{ "shape":"TagValuesList", "documentation":"Cost allocation resource tags 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":"Number of hours during the lookback period covered by reservations.
" }, "SavingsPlansCoveredHoursInLookbackPeriod":{ "shape":"GenericString", "documentation":"Number of hours during the lookback period covered by Savings Plans.
" }, "OnDemandHoursInLookbackPeriod":{ "shape":"GenericString", "documentation":"Number of hours during the lookback period billed at On Demand rates.
" }, "TotalRunningHoursInLookbackPeriod":{ "shape":"GenericString", "documentation":"The total number of hours the instance ran during the lookback period.
" }, "MonthlyCost":{ "shape":"GenericString", "documentation":"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 that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01, AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01, AWS retrieves cost and usage data from the start date up to, but not including, 2017-05-01.
The time period that you want the usage and costs for.
" }, "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 will be 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", "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", "CACHE_ENGINE", "INSTANCE_TYPE_FAMILY", "BILLING_ENTITY", "RESERVATION_ID", "RESOURCE_ID", "RIGHTSIZING_TYPE", "SAVINGS_PLANS_TYPE", "SAVINGS_PLAN_ARN", "PAYMENT_OPTION" ] }, "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.
The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute, Amazon Elasticsearch Service, Amazon ElastiCache, Amazon Redshift, and Amazon Relational Database Service.
The metadata that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
The value of a dimension with a specific attribute.
" }, "Attributes":{ "shape":"Attributes", "documentation":"The attribute that applies to a specific Dimension.
The metadata of a specific type that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
The instance family of the recommended reservation.
" }, "InstanceType":{ "shape":"GenericString", "documentation":"The type of instance that AWS recommends.
" }, "Region":{ "shape":"GenericString", "documentation":"The AWS 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":"Whether the recommended reservation is dedicated or shared.
" }, "CurrentGeneration":{ "shape":"GenericBoolean", "documentation":"Whether the recommendation is for a current-generation instance.
" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"Whether the recommended reservation is size flexible.
" } }, "documentation":"Details about the Amazon EC2 instances that AWS recommends that you purchase.
" }, "EC2ResourceDetails":{ "type":"structure", "members":{ "HourlyOnDemandRate":{ "shape":"GenericString", "documentation":"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":"Memory capacity of Amazon Web Services instance.
" }, "NetworkPerformance":{ "shape":"GenericString", "documentation":"Network performance capacity of the Amazon Web Services instance.
" }, "Storage":{ "shape":"GenericString", "documentation":"The disk storage of the Amazon Web Services instance (Not EBS storage).
" }, "Vcpu":{ "shape":"GenericString", "documentation":"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":"Maximum observed or expected CPU utilization of the instance.
" }, "MaxMemoryUtilizationPercentage":{ "shape":"GenericString", "documentation":"Maximum observed or expected memory utilization of the instance.
" }, "MaxStorageUtilizationPercentage":{ "shape":"GenericString", "documentation":"Maximum observed or expected storage utilization of the instance (does not measure EBS storage).
" } }, "documentation":"Utilization metrics of the instance.
" }, "EC2Specification":{ "type":"structure", "members":{ "OfferingClass":{ "shape":"OfferingClass", "documentation":"Whether you want a recommendation for standard or convertible reservations.
" } }, "documentation":"The Amazon EC2 hardware specifications that you want AWS to provide recommendations for.
" }, "ESInstanceDetails":{ "type":"structure", "members":{ "InstanceClass":{ "shape":"GenericString", "documentation":"The class of instance that AWS recommends.
" }, "InstanceSize":{ "shape":"GenericString", "documentation":"The size of instance that AWS recommends.
" }, "Region":{ "shape":"GenericString", "documentation":"The AWS Region of the recommended reservation.
" }, "CurrentGeneration":{ "shape":"GenericBoolean", "documentation":"Whether the recommendation is for a current-generation instance.
" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"Whether the recommended reservation is size flexible.
" } }, "documentation":"Details about the Amazon ES instances that AWS 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 AWS recommends.
" }, "Region":{ "shape":"GenericString", "documentation":"The AWS Region of the recommended reservation.
" }, "ProductDescription":{ "shape":"GenericString", "documentation":"The description of the recommended reservation.
" }, "CurrentGeneration":{ "shape":"GenericBoolean", "documentation":"Whether the recommendation is for a current generation instance.
" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"Whether the recommended reservation is size flexible.
" } }, "documentation":"Details about the Amazon ElastiCache instances that AWS 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.
Return results that match both Dimension objects.
Return results that don't match a Dimension object.
The specific Dimension to use for Expression.
The specific Tag to use for Expression.
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
The specific CostCategory used for Expression.
Use Expression to filter by cost or by usage. There are two patterns:
Simple dimension values - 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. The Expression for that looks like this:
{ \"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", “us-west-1” ] } }
The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values 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. This allows you to filter on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer). The Expression for that looks like this:
{ \"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\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } }
For GetRightsizingRecommendation action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.
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 created for your query.
" }, "ForecastResultsByTime":{ "type":"list", "member":{"shape":"ForecastResult"} }, "GenericBoolean":{"type":"boolean"}, "GenericString":{"type":"string"}, "GetCostAndUsageRequest":{ "type":"structure", "required":["TimePeriod"], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"Sets the start and end dates for retrieving AWS 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.
Sets the AWS 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.
Filters AWS 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.
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 vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.
Metrics is required for GetCostAndUsage requests.
You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.
When you group by tag key, you get all tag values, including empty strings.
Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, RECORD_TYPE, and USAGE_TYPE.
The token to retrieve the next set of results. AWS 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. AWS 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.
The time period that is covered by the results in the response.
" } } }, "GetCostAndUsageWithResourcesRequest":{ "type":"structure", "required":["TimePeriod"], "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.
Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, MONTHLY, DAILY, or HOURLY.
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.
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, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.
Metrics is required for GetCostAndUsageWithResources requests.
You can group Amazon Web Services costs using up to two different groups: either dimensions, tag keys, or both.
" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"The token to retrieve the next set of results. AWS 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. AWS 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.
The time period that is covered by the results in the response.
" } } }, "GetCostForecastRequest":{ "type":"structure", "required":[ "TimePeriod", "Metric", "Granularity" ], "members":{ "TimePeriod":{ "shape":"DateInterval", "documentation":"The period of time that you want the forecast to cover.
" }, "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
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.
The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.
" }, "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.
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.
The value that you want to search the filter values 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.
The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.
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.
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 AWS 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 AWS 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 AWS 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.
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 AWS ID of the member account.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
REGION - The AWS 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 AWS 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 AWS ID of the member account.
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
The token to retrieve the next set of results. AWS 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 AWS 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 AWS 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 AWS 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.
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 AWS ID of the member account.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
REGION - The AWS 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 AWS 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 AWS ID of the member account.
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
The number of results that AWS 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. AWS 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.
You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TENANCY
The granularity of the AWS 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.
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.
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.
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
" } }, "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. AWS 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 is associated with the recommendation.
" }, "Service":{ "shape":"GenericString", "documentation":"The specific service that you want recommendations for.
" }, "AccountScope":{ "shape":"AccountScope", "documentation":"The account scope that you want recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations.
Valid values are PAYER and LINKED.
The number of previous days that you want AWS 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 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.
Groups only by SUBSCRIPTION_ID. Metadata is included.
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.
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.
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
" } } }, "GetReservationUtilizationResponse":{ "type":"structure", "required":["UtilizationsByTime"], "members":{ "UtilizationsByTime":{ "shape":"UtilizationsByTime", "documentation":"The amount of time that you used your RIs.
" }, "Total":{ "shape":"ReservationAggregates", "documentation":"The total amount of time that you used your RIs.
" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"The token for the next set of retrievable results. AWS 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"}, "Service":{ "shape":"GenericString", "documentation":"The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is \"AmazonEC2\".
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.
" } } }, "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.
You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
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.
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.
The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.
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.
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 requested.
" }, "TermInYears":{ "shape":"TermInYears", "documentation":"The savings plan recommendation term used to generated these recommendations.
" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"The payment option used to generate these recommendations.
" }, "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 used to generate the recommendation.
" } } }, "GetSavingsPlansPurchaseRecommendationResponse":{ "type":"structure", "members":{ "Metadata":{ "shape":"SavingsPlansPurchaseRecommendationMetadata", "documentation":"Information regarding 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. AWS 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.
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.
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.
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.
The granularity of the Amazon Web Services utillization data for your Savings Plans.
The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.
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.
The amount of cost/commitment you used your Savings Plans. This allows you 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.
The key of the tag that you want to return values for.
" }, "NextPageToken":{ "shape":"NextPageToken", "documentation":"The token to retrieve the next set of results. AWS 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. AWS 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 AWS 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 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.
Which metric Cost Explorer uses to create your forecast.
Valid values for a GetUsageForecast call are the following:
USAGE_QUANTITY
NORMALIZED_USAGE_AMOUNT
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.
The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.
" }, "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.
" } } }, "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.
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"}, "GroupDefinitionType":{ "type":"string", "enum":[ "DIMENSION", "TAG", "COST_CATEGORY" ] }, "GroupDefinitions":{ "type":"list", "member":{"shape":"GroupDefinition"} }, "Groups":{ "type":"list", "member":{"shape":"Group"} }, "InstanceDetails":{ "type":"structure", "members":{ "EC2InstanceDetails":{ "shape":"EC2InstanceDetails", "documentation":"The Amazon EC2 instances that AWS recommends that you purchase.
" }, "RDSInstanceDetails":{ "shape":"RDSInstanceDetails", "documentation":"The Amazon RDS instances that AWS recommends that you purchase.
" }, "RedshiftInstanceDetails":{ "shape":"RedshiftInstanceDetails", "documentation":"The Amazon Redshift instances that AWS recommends that you purchase.
" }, "ElastiCacheInstanceDetails":{ "shape":"ElastiCacheInstanceDetails", "documentation":"The ElastiCache instances that AWS recommends that you purchase.
" }, "ESInstanceDetails":{ "shape":"ESInstanceDetails", "documentation":"The Amazon ES instances that AWS recommends that you purchase.
" } }, "documentation":"Details about the instances that AWS 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 }, "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.
You can use this information to retrieve the full Cost Category information using DescribeCostCategory.
A reference to a Cost Category containing 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.
" } } }, "LookbackPeriodInDays":{ "type":"string", "enum":[ "SEVEN_DAYS", "THIRTY_DAYS", "SIXTY_DAYS" ] }, "MaxResults":{ "type":"integer", "min":1 }, "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"}, "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"} }, "ModifyRecommendationDetail":{ "type":"structure", "members":{ "TargetInstances":{ "shape":"TargetInstancesList", "documentation":"Identifies whether this instance type is the Amazon Web Services default recommendation.
" } }, "documentation":"Details on the modification recommendation.
" }, "NetRISavings":{"type":"string"}, "NextPageToken":{"type":"string"}, "NonNegativeInteger":{ "type":"integer", "min":0 }, "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" ] }, "PredictionIntervalLevel":{ "type":"integer", "max":99, "min":51 }, "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 AWS recommends.
" }, "Region":{ "shape":"GenericString", "documentation":"The AWS 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":"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":"Whether the recommendation is for a current-generation instance.
" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"Whether the recommended reservation is size flexible.
" } }, "documentation":"Details about the Amazon RDS instances that AWS recommends that you purchase.
" }, "RedshiftInstanceDetails":{ "type":"structure", "members":{ "Family":{ "shape":"GenericString", "documentation":"The instance family of the recommended reservation.
" }, "NodeType":{ "shape":"GenericString", "documentation":"The type of node that AWS recommends.
" }, "Region":{ "shape":"GenericString", "documentation":"The AWS Region of the recommended reservation.
" }, "CurrentGeneration":{ "shape":"GenericBoolean", "documentation":"Whether the recommendation is for a current-generation instance.
" }, "SizeFlexEligible":{ "shape":"GenericBoolean", "documentation":"Whether the recommended reservation is size flexible.
" } }, "documentation":"Details about the Amazon Redshift instances that AWS 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, 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":"How many Amazon EC2 reservation hours that you purchased, 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, 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, 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 would cost if charged On-Demand rates.
" }, "NetRISavings":{ "shape":"NetRISavings", "documentation":"How much you saved due to purchasing and utilizing reservation. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed.
How much you could save if you use your entire reservation.
" }, "AmortizedUpfrontFee":{ "shape":"AmortizedUpfrontFee", "documentation":"The upfront cost of your reservation, amortized over the reservation period.
" }, "AmortizedRecurringFee":{ "shape":"AmortizedRecurringFee", "documentation":"The monthly cost of your reservation, amortized over the reservation period.
" }, "TotalAmortizedFee":{ "shape":"TotalAmortizedFee", "documentation":"The total cost of your reservation, amortized over the reservation period.
" } }, "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 AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.
" }, "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", "documentation":"How many days of previous usage that AWS 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.
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 AWS recommends for purchase.
" }, "ReservationPurchaseRecommendationDetail":{ "type":"structure", "members":{ "AccountId":{ "shape":"GenericString", "documentation":"The account that this RI recommendation is for.
" }, "InstanceDetails":{ "shape":"InstanceDetails", "documentation":"Details about the instances that AWS recommends that you purchase.
" }, "RecommendedNumberOfInstancesToPurchase":{ "shape":"GenericString", "documentation":"The number of instances that AWS recommends that you purchase.
" }, "RecommendedNormalizedUnitsToPurchase":{ "shape":"GenericString", "documentation":"The number of normalized units that AWS recommends that you purchase.
" }, "MinimumNumberOfInstancesUsedPerHour":{ "shape":"GenericString", "documentation":"The minimum number of instances that you used in an hour during the historical period. AWS 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. AWS 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. AWS 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. AWS 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. AWS 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. AWS uses this to calculate your recommended reservation purchases.
" }, "AverageUtilization":{ "shape":"GenericString", "documentation":"The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.
" }, "EstimatedBreakEvenInMonths":{ "shape":"GenericString", "documentation":"How long AWS estimates that it takes for this instance to start saving you money, in months.
" }, "CurrencyCode":{ "shape":"GenericString", "documentation":"The currency code that AWS used to calculate the costs for this instance.
" }, "EstimatedMonthlySavingsAmount":{ "shape":"GenericString", "documentation":"How much AWS estimates that this specific recommendation could save you in a month.
" }, "EstimatedMonthlySavingsPercentage":{ "shape":"GenericString", "documentation":"How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.
" }, "EstimatedMonthlyOnDemandCost":{ "shape":"GenericString", "documentation":"How much AWS estimates that you spend on On-Demand Instances in a month.
" }, "EstimatedReservationCostForLookbackPeriod":{ "shape":"GenericString", "documentation":"How much AWS estimates that you would have spent 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 time stamp for when AWS made this recommendation.
" } }, "documentation":"Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation.
" }, "ReservationPurchaseRecommendationSummary":{ "type":"structure", "members":{ "TotalEstimatedMonthlySavingsAmount":{ "shape":"GenericString", "documentation":"The total amount that AWS estimates that this recommendation could save you in a month.
" }, "TotalEstimatedMonthlySavingsPercentage":{ "shape":"GenericString", "documentation":"The total amount that AWS 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 AWS 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 on the Amazon EC2 resource.
" } }, "documentation":"Details on the resource.
" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"The specified ARN in the request doesn't exist.
", "exception":true }, "ResourceUtilization":{ "type":"structure", "members":{ "EC2ResourceUtilization":{ "shape":"EC2ResourceUtilization", "documentation":"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":"Whether the result is estimated.
" } }, "documentation":"The result that is 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":"Recommendation to either terminate or modify the resource.
" }, "ModifyRecommendationDetail":{ "shape":"ModifyRecommendationDetail", "documentation":"Details for modification recommendations.
" }, "TerminateRecommendationDetail":{ "shape":"TerminateRecommendationDetail", "documentation":"Details for termination recommendations.
" } }, "documentation":"Recommendations to rightsize resources.
" }, "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 time stamp for when Amazon Web Services made this recommendation.
" }, "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", "documentation":"How many days of previous usage that Amazon Web Services considers when making this recommendation.
" } }, "documentation":"Metadata for this recommendation set.
" }, "RightsizingRecommendationSummary":{ "type":"structure", "members":{ "TotalRecommendationCount":{ "shape":"GenericString", "documentation":"Total number of instance recommendations.
" }, "EstimatedTotalMonthlySavingsAmount":{ "shape":"GenericString", "documentation":"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":"Savings percentage based on the recommended modifications, relative to the total On Demand costs associated with these instances.
" } }, "documentation":"Summary of rightsizing recommendations
" }, "RightsizingType":{ "type":"string", "enum":[ "TERMINATE", "MODIFY" ] }, "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.
The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.
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.
The amount of Savings Plans eligible usage that the Savings Plans covered.
" }, "TimePeriod":{"shape":"DateInterval"} }, "documentation":"The amount of Savings Plans eligible usage that is 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 is 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 Planscovered 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"} }, "SavingsPlansDetails":{ "type":"structure", "members":{ "Region":{ "shape":"GenericString", "documentation":"A collection of AWS resources in a geographic area. Each AWS 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 used to distinguish Savings Plans from one another.
" } }, "documentation":"Attribute details on a specific Savings Plan.
" }, "SavingsPlansPurchaseRecommendation":{ "type":"structure", "members":{ "SavingsPlansType":{ "shape":"SupportedSavingsPlansType", "documentation":"The requested Savings Plans recommendation type.
" }, "TermInYears":{ "shape":"TermInYears", "documentation":"The Savings Plans recommendation term in years, used to generate the recommendation.
" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"The payment option used to generate the recommendation.
" }, "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", "documentation":"The lookback period in days, used to generate the recommendation.
" }, "SavingsPlansPurchaseRecommendationDetails":{ "shape":"SavingsPlansPurchaseRecommendationDetailList", "documentation":"Details for the Savings Plans we recommend you to 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.
The upfront cost of the recommended Savings Plans, based on the selected payment option.
" }, "EstimatedROI":{ "shape":"GenericString", "documentation":"The estimated return on investment based on the recommended Savings Plans purchased. This is calculated as estimatedSavingsAmount/ estimatedSPCost*100.
The currency code 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 would 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 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 configuration 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.
" } }, "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 showing when the recommendations were generated.
" } }, "documentation":"Metadata about your Savings Plans Purchase Recommendations.
" }, "SavingsPlansPurchaseRecommendationSummary":{ "type":"structure", "members":{ "EstimatedROI":{ "shape":"GenericString", "documentation":"The estimated return on investment based on the recommended Savings Plans and estimated savings.
" }, "CurrencyCode":{ "shape":"GenericString", "documentation":"The currency code 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 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.
The estimated monthly savings amount, based on the recommended Savings Plans purchase.
" }, "EstimatedOnDemandCostWithCurrentCommitment":{ "shape":"GenericString", "documentation":"The estimated On-Demand costs you would expect with no additional commitment, 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 are accumulating for the usage that is 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 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 was not 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.
The measurement of how well you are 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 saved by using existing Savings Plans. Savings returns both net savings from Savings Plans, as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
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 saved by using existing Savings Plans. Savings returns both net savings from Savings Plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
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.
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 as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
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. Master accounts in an organization have access to member accounts. You can use GetDimensionValues to determine the possible dimension values.
You've reached the limit on the number of resources you can create, or exceeded the size of an individual resources.
", "exception":true }, "ServiceSpecification":{ "type":"structure", "members":{ "EC2Specification":{ "shape":"EC2Specification", "documentation":"The Amazon EC2 hardware specifications that you want AWS to provide recommendations for.
" } }, "documentation":"Hardware specifications for the service that you want recommendations for.
" }, "SupportedSavingsPlansType":{ "type":"string", "enum":[ "COMPUTE_SP", "EC2_INSTANCE_SP" ] }, "TagKey":{"type":"string"}, "TagList":{ "type":"list", "member":{"shape":"Entity"} }, "TagValues":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"The key for the tag.
" }, "Values":{ "shape":"Values", "documentation":"The specific value of the tag.
" } }, "documentation":"The values that are available for a tag.
" }, "TagValuesList":{ "type":"list", "member":{"shape":"TagValues"} }, "TargetInstance":{ "type":"structure", "members":{ "EstimatedMonthlyCost":{ "shape":"GenericString", "documentation":"Expected cost to operate this instance type on a monthly basis.
" }, "EstimatedMonthlySavings":{ "shape":"GenericString", "documentation":"Estimated savings resulting 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":"Indicates whether or not this recommendation is the defaulted Amazon Web Services recommendation.
" }, "ResourceDetails":{ "shape":"ResourceDetails", "documentation":"Details on the target instance type.
" }, "ExpectedResourceUtilization":{ "shape":"ResourceUtilization", "documentation":"Expected utilization metrics for target 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":"Estimated savings resulting 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.
" }, "TotalActualHours":{"type":"string"}, "TotalActualUnits":{"type":"string"}, "TotalAmortizedFee":{"type":"string"}, "TotalPotentialRISavings":{"type":"string"}, "TotalRunningHours":{"type":"string"}, "TotalRunningNormalizedUnits":{"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.
The unique identifier for your Cost Category.
" }, "RuleVersion":{"shape":"CostCategoryRuleVersion"}, "Rules":{ "shape":"CostCategoryRulesList", "documentation":" UpdateCostCategoryDefinition supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is LINKED_ACCOUNT.
Root level OR is not supported. We recommend you create a separate rule instead.
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.
" } } }, "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.
" } } }, "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"}, "Values":{ "type":"list", "member":{"shape":"Value"} }, "YearMonthDay":{ "type":"string", "pattern":"(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?" }, "ZonedDateTime":{ "type":"string", "documentation":"The time period 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":"The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
https://ce.us-east-1.amazonaws.com
For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing.
" }