String anomalyId
The unique identifier for the anomaly.
String anomalyStartDate
The first day the anomaly is detected.
String anomalyEndDate
The last day the anomaly is detected.
String dimensionValue
The dimension for the anomaly (for example, an Amazon Web Service in a service monitor).
List<E> rootCauses
The list of identified root causes for the anomaly.
AnomalyScore anomalyScore
The latest and maximum score for the anomaly.
Impact impact
The dollar impact for the anomaly.
String monitorArn
The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.
String feedback
The feedback value.
String monitorArn
The Amazon Resource Name (ARN) value.
String monitorName
The name of the monitor.
String creationDate
The date when the monitor was created.
String lastUpdatedDate
The date when the monitor was last updated.
String lastEvaluatedDate
The date when the monitor last evaluated for anomalies.
String monitorType
The possible type values.
String monitorDimension
The dimensions to evaluate.
Expression monitorSpecification
Integer dimensionalValueCount
The value for evaluated dimensions.
String subscriptionArn
The AnomalySubscription
Amazon Resource Name (ARN).
String accountId
Your unique account identifier.
List<E> monitorArnList
A list of cost anomaly monitors.
List<E> subscribers
A list of subscribers to notify.
Double threshold
(deprecated)
An absolute dollar value that must be exceeded by the anomaly's total impact (see Impact for more details) for an anomaly notification to be generated.
This field has been deprecated. To specify a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.
One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.
String frequency
The frequency that anomaly notifications are sent. Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see Creating an Amazon SNS topic for anomaly notifications.
String subscriptionName
The name for the subscription.
Expression thresholdExpression
An Expression
object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested
expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE
and
ANOMALY_TOTAL_IMPACT_PERCENTAGE
, corresponding to an anomaly’s TotalImpact and
TotalImpactPercentage, respectively (see Impact for more
details). The supported nested expression types are AND
and OR
. The match option
GREATER_THAN_OR_EQUAL
is required. Values must be numbers between 0 and 10,000,000,000 in string
format.
One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.
The following are examples of valid ThresholdExpressions:
Absolute threshold:
{ "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }
Percentage threshold:
{ "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }
AND
two thresholds together:
{ "And": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }
OR
two thresholds together:
{ "Or": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }
String tagKey
The key for the cost allocation tag.
String type
The type of cost allocation tag. You can use AWSGenerated
or UserDefined
type tags.
AWSGenerated
type tags are tags that Amazon Web Services defines and applies to support Amazon Web
Services resources for cost allocation purposes. UserDefined
type tags are tags that you define,
create, and apply to resources.
String status
The status of a cost allocation tag.
String lastUpdatedDate
The last date that the tag was either activated or deactivated.
String lastUsedDate
The last month that the tag was used on an Amazon Web Services resource.
String costCategoryArn
The unique identifier for your Cost Category.
String effectiveStart
The effective start date of your Cost Category.
String effectiveEnd
The effective end date of your Cost Category.
String name
String ruleVersion
List<E> rules
The rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
List<E> splitChargeRules
The split charge rules that are used to allocate your charges between your Cost Category values.
List<E> processingStatus
The list of processing statuses for Cost Management products for a specific cost category.
String defaultValue
String dimensionName
The name of the dimension that's used to group costs.
If you specify LINKED_ACCOUNT_NAME
, the cost category value is based on account name. If you specify
TAG
, the cost category value is based on the value of the specified tag key.
String dimensionKey
The key to extract cost category values.
String costCategoryArn
The unique identifier for your Cost Category.
String name
String effectiveStart
The Cost Category's effective start date.
String effectiveEnd
The Cost Category's effective end date.
Integer numberOfRules
The number of rules that are associated with a specific Cost Category.
List<E> processingStatus
The list of processing statuses for Cost Management products for a specific cost category.
List<E> values
A list of unique cost category values in a specific cost category.
String defaultValue
String value
Expression rule
An Expression
object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only
dimensions supported are LINKED_ACCOUNT
, SERVICE_CODE
, RECORD_TYPE
,
LINKED_ACCOUNT_NAME
, REGION
, and USAGE_TYPE
.
RECORD_TYPE
is a dimension used for Cost Explorer APIs, and is also supported for Cost Category
expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON
editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide.
CostCategoryInheritedValueDimension inheritedValue
The value the line item is categorized as if the line item contains the matched dimension.
String type
You can define the CostCategoryRule
rule type as either REGULAR
or
INHERITED_VALUE
. The INHERITED_VALUE
rule type adds the flexibility to define a rule
that dynamically inherits the cost category value. This value is from the dimension value that's defined by
CostCategoryInheritedValueDimension
. For example, suppose that you want to costs to be dynamically
grouped based on the value of a specific tag key. First, choose an inherited value rule type, and then choose the
tag dimension and specify the tag key to use.
String source
The Cost Category value that you want to split. That value can't be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.
List<E> targets
The Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.
String method
The method that's used to define how to split your source costs across your targets.
Proportional
- Allocates charges across your targets based on the proportional weighted cost of each
target.
Fixed
- Allocates charges across your targets based on your defined allocation percentage.
>Even
- Allocates costs evenly across all targets.
List<E> parameters
The parameters for a split charge method. This is only required for the FIXED
method.
String key
List<E> values
The specific value of the Cost Category.
List<E> matchOptions
The match options that you can use to filter your results. MatchOptions is only applicable for actions related to
cost category. The default values for MatchOptions
is EQUALS
and
CASE_SENSITIVE
.
CoverageHours coverageHours
The amount of instance usage that the reservation covered, in hours.
CoverageNormalizedUnits coverageNormalizedUnits
The amount of instance usage that the reservation covered, in normalized units.
CoverageCost coverageCost
The amount of cost that the reservation covered.
DateInterval timePeriod
The period that this coverage was used over.
List<E> groups
The groups of instances that the reservation covered.
Coverage total
The total reservation coverage, in hours.
String onDemandCost
How much an On-Demand Instance costs.
String onDemandHours
The number of instance running hours that On-Demand Instances covered.
String reservedHours
The number of instance running hours that reservations covered.
String totalRunningHours
The total instance usage, in hours.
String coverageHoursPercentage
The percentage of instance hours that a reservation covered.
String onDemandNormalizedUnits
The number of normalized units that are covered by On-Demand Instances instead of a reservation.
String reservedNormalizedUnits
The number of normalized units that a reservation covers.
String totalRunningNormalizedUnits
The total number of normalized units that you used.
String coverageNormalizedUnitsPercentage
The percentage of your used instance normalized units that a reservation covers.
AnomalyMonitor anomalyMonitor
The cost anomaly detection monitor object that you want to create.
List<E> resourceTags
An optional list of tags to associate with the specified
AnomalyMonitor
. You can use resource tags to control access to your monitor
using
IAM policies.
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use
The maximum length of a key is 128 characters
The maximum length of a value is 256 characters
Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-
Keys and values are case sensitive
Keys and values are trimmed for any leading or trailing whitespaces
Don’t use aws:
as a prefix for your keys. This prefix is reserved for Amazon Web Services use
String monitorArn
The unique identifier of your newly created cost anomaly detection monitor.
AnomalySubscription anomalySubscription
The cost anomaly subscription object that you want to create.
List<E> resourceTags
An optional list of tags to associate with the specified
AnomalySubscription
. You can use resource tags to control access to your
subscription
using IAM policies.
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use
The maximum length of a key is 128 characters
The maximum length of a value is 256 characters
Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-
Keys and values are case sensitive
Keys and values are trimmed for any leading or trailing whitespaces
Don’t use aws:
as a prefix for your keys. This prefix is reserved for Amazon Web Services use
String subscriptionArn
The unique identifier of your newly created cost anomaly subscription.
String name
String effectiveStart
The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.
String ruleVersion
List<E> rules
The Cost Category rules used to categorize costs. For more information, see CostCategoryRule.
String defaultValue
List<E> splitChargeRules
The split charge rules used to allocate your charges between your Cost Category values.
List<E> resourceTags
An optional list of tags to associate with the specified
CostCategory
. You can use resource tags to control access to your cost category
using IAM policies.
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use
The maximum length of a key is 128 characters
The maximum length of a value is 256 characters
Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-
Keys and values are case sensitive
Keys and values are trimmed for any leading or trailing whitespaces
Don’t use aws:
as a prefix for your keys. This prefix is reserved for Amazon Web Services use
String resourceId
Resource ID of the current instance.
String instanceName
The name that you given an instance. This field shows as blank if you haven't given the instance a name.
List<E> tags
Cost allocation resource tags that are applied to the instance.
ResourceDetails resourceDetails
Details about the resource and utilization.
ResourceUtilization resourceUtilization
Utilization information of the current instance during the lookback period.
String reservationCoveredHoursInLookbackPeriod
The number of hours during the lookback period that's covered by reservations.
String savingsPlansCoveredHoursInLookbackPeriod
The number of hours during the lookback period that's covered by Savings Plans.
String onDemandHoursInLookbackPeriod
The number of hours during the lookback period that's billed at On-Demand rates.
String totalRunningHoursInLookbackPeriod
The total number of hours that the instance ran during the lookback period.
String monthlyCost
The current On-Demand cost of operating this instance on a monthly basis.
String currencyCode
The currency code that Amazon Web Services used to calculate the costs for this instance.
String start
The beginning of the time period. The start date is inclusive. For example, if start
is
2017-01-01
, Amazon Web Services retrieves cost and usage data starting at 2017-01-01
up
to the end date. The start date must be equal to or no later than the current date to avoid a validation error.
String end
The end of the time period. The end date is exclusive. For example, if end
is
2017-05-01
, Amazon Web Services retrieves cost and usage data from the start date up to, but not
including, 2017-05-01
.
String monitorArn
The unique identifier of the cost anomaly monitor that you want to delete.
String subscriptionArn
The unique identifier of the cost anomaly subscription that you want to delete.
String costCategoryArn
The unique identifier for your Cost Category.
CostCategory costCategory
String key
The names of the metadata types that you can use to filter and group your results. For example, AZ
returns a list of Availability Zones.
Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.
LINK_ACCOUNT_NAME
and SERVICE_CODE
can only be used in CostCategoryRule.
ANOMALY_TOTAL_IMPACT_ABSOLUTE
and ANOMALY_TOTAL_IMPACT_PERCENTAGE
can only be used in
AnomalySubscriptions.
List<E> values
The metadata values that you can use to filter and group your results. You can use
GetDimensionValues
to find specific values.
List<E> matchOptions
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category and Anomaly Subscriptions.
Refer to the documentation for each specific API to see what is supported.
The default values for MatchOptions
are EQUALS
and CASE_SENSITIVE
.
String diskReadOpsPerSecond
The maximum number of read operations per second.
String diskWriteOpsPerSecond
The maximum number of write operations per second.
String diskReadBytesPerSecond
The maximum read throughput operations per second.
String diskWriteBytesPerSecond
The maximum write throughput operations per second.
String ebsReadOpsPerSecond
The maximum number of read operations per second.
String ebsWriteOpsPerSecond
The maximum number of write operations per second.
String ebsReadBytesPerSecond
The maximum size of read operations per second
String ebsWriteBytesPerSecond
The maximum size of write operations per second.
String family
The instance family of the recommended reservation.
String instanceType
The type of instance that Amazon Web Services recommends.
String region
The Amazon Web Services Region of the recommended reservation.
String availabilityZone
The Availability Zone of the recommended reservation.
String platform
The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.
String tenancy
Determines whether the recommended reservation is dedicated or shared.
Boolean currentGeneration
Determines whether the recommendation is for a current-generation instance.
Boolean sizeFlexEligible
Determines whether the recommended reservation is size flexible.
String hourlyOnDemandRate
The hourly public On-Demand rate for the instance type.
String instanceType
The type of Amazon Web Services instance.
String platform
The platform of the Amazon Web Services instance. The platform is the specific combination of operating system, license model, and software on an instance.
String region
The Amazon Web Services Region of the instance.
String sku
The SKU of the product.
String memory
The memory capacity of the Amazon Web Services instance.
String networkPerformance
The network performance capacity of the Amazon Web Services instance.
String storage
The disk storage of the Amazon Web Services instance. This doesn't include EBS storage.
String vcpu
The number of VCPU cores in the Amazon Web Services instance type.
String maxCpuUtilizationPercentage
The maximum observed or expected CPU utilization of the instance.
String maxMemoryUtilizationPercentage
The maximum observed or expected memory utilization of the instance.
String maxStorageUtilizationPercentage
The maximum observed or expected storage utilization of the instance. This doesn't include EBS storage.
EBSResourceUtilization eBSResourceUtilization
The EBS field that contains a list of EBS metrics that are associated with the current instance.
DiskResourceUtilization diskResourceUtilization
The field that contains a list of disk (local storage) metrics that are associated with the current instance.
NetworkResourceUtilization networkResourceUtilization
The network field that contains a list of network metrics that are associated with the current instance.
String offeringClass
Indicates whether you want a recommendation for standard or convertible reservations.
String family
The instance family of the recommended reservation.
String nodeType
The type of node that Amazon Web Services recommends.
String region
The Amazon Web Services Region of the recommended reservation.
String productDescription
The description of the recommended reservation.
Boolean currentGeneration
Determines whether the recommendation is for a current generation instance.
Boolean sizeFlexEligible
Determines whether the recommended reservation is size flexible.
String instanceClass
The class of instance that Amazon Web Services recommends.
String instanceSize
The size of instance that Amazon Web Services recommends.
String region
The Amazon Web Services Region of the recommended reservation.
Boolean currentGeneration
Determines whether the recommendation is for a current-generation instance.
Boolean sizeFlexEligible
Determines whether the recommended reservation is size flexible.
List<E> or
Return results that match either Dimension
object.
List<E> and
Return results that match both Dimension
objects.
Expression not
Return results that don't match a Dimension
object.
DimensionValues dimensions
The specific Dimension
to use for Expression
.
TagValues tags
The specific Tag
to use for Expression
.
CostCategoryValues costCategories
The filter that's based on CostCategory
values.
DateInterval timePeriod
The period of time that the forecast covers.
String meanValue
The mean value of the forecast.
String predictionIntervalLowerBound
The lower limit for the prediction interval.
String predictionIntervalUpperBound
The upper limit for the prediction interval.
String recommendationId
Indicates the ID for this specific recommendation.
String generationStatus
Indicates whether the recommendation generation succeeded, is processing, or failed.
String generationStartedTime
Indicates the start time of the recommendation generation.
String generationCompletionTime
Indicates the completion time of the recommendation generation.
String estimatedCompletionTime
Indicates the estimated time for when the recommendation generation will complete.
String monitorArn
Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon Resource Name (ARN).
AnomalyDateInterval dateInterval
Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object will have an
AnomalyEndDate
in the specified time range.
String feedback
Filters anomaly results by the feedback field on the anomaly object.
TotalImpactFilter totalImpact
Filters anomaly results by the total impact field on the anomaly object. For example, you can filter anomalies
GREATER_THAN 200.00
to retrieve anomalies, with an estimated dollar impact greater than 200.
String nextPageToken
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.
Integer maxResults
The number of entries a paginated response contains.
List<E> monitorArnList
A list of cost anomaly monitor ARNs.
String nextPageToken
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.
Integer maxResults
The number of entries that a paginated response contains.
List<E> anomalyMonitors
A list of cost anomaly monitors that includes the detailed metadata for each monitor.
String nextPageToken
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.
List<E> subscriptionArnList
A list of cost anomaly subscription ARNs.
String monitorArn
Cost anomaly monitor ARNs.
String nextPageToken
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.
Integer maxResults
The number of entries a paginated response contains.
List<E> anomalySubscriptions
A list of cost anomaly subscriptions that includes the detailed metadata for each one.
String nextPageToken
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.
DateInterval timePeriod
Sets the start date and end date for retrieving Amazon Web Services costs. The start date is inclusive, but the
end date is exclusive. For example, if start
is 2017-01-01
and end
is
2017-05-01
, then the cost and usage data is retrieved from 2017-01-01
up to and
including 2017-04-30
but not including 2017-05-01
.
String granularity
Sets the Amazon Web Services cost granularity to MONTHLY
or DAILY
, or
HOURLY
. If Granularity
isn't set, the response object doesn't include the
Granularity
, either MONTHLY
or DAILY
, or HOURLY
.
Expression filter
Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE
and
LINKED_ACCOUNT
and get the costs that are associated with that account's usage of that service. You
can nest Expression
objects to define any combination of dimension filters. For more information,
see Expression.
Valid values for MatchOptions
for Dimensions
are EQUALS
and
CASE_SENSITIVE
.
Valid values for MatchOptions
for CostCategories
and Tags
are
EQUALS
, ABSENT
, and CASE_SENSITIVE
. Default values are EQUALS
and CASE_SENSITIVE
.
List<E> metrics
Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.
Valid values are AmortizedCost
, BlendedCost
, NetAmortizedCost
,
NetUnblendedCost
, NormalizedUsageAmount
, UnblendedCost
, and
UsageQuantity
.
If you return the UsageQuantity
metric, the service aggregates all usage numbers without taking into
account the units. For example, if you aggregate usageQuantity
across all of Amazon EC2, the results
aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for
example, hours and GB). To get more meaningful UsageQuantity
metrics, filter by
UsageType
or UsageTypeGroups
.
Metrics
is required for GetCostAndUsage
requests.
List<E> groupBy
You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.
Valid values for the DIMENSION
type are AZ
, INSTANCE_TYPE
,
LEGAL_ENTITY_NAME
, INVOICING_ENTITY
, LINKED_ACCOUNT
,
OPERATION
, PLATFORM
, PURCHASE_TYPE
, SERVICE
,
TENANCY
, RECORD_TYPE
, and USAGE_TYPE
.
When you group by the TAG
type and include a valid tag key, you get all tag values, including empty
strings.
String nextPageToken
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.
String nextPageToken
The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
List<E> groupDefinitions
The groups that are specified by the Filter
or GroupBy
parameters in the request.
List<E> resultsByTime
The time period that's covered by the results in the response.
List<E> dimensionValueAttributes
The attributes that apply to a specific dimension value. For example, if the value is a linked account, the attribute is that account name.
DateInterval timePeriod
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
.
String granularity
Sets the Amazon Web Services cost granularity to MONTHLY
, DAILY
, or HOURLY
. If Granularity
isn't set, the response object doesn't include the Granularity
,
MONTHLY
, DAILY
, or HOURLY
.
Expression filter
Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE
and
LINKED_ACCOUNT
and get the costs that are associated with that account's usage of that service. You
can nest Expression
objects to define any combination of dimension filters. For more information,
see Expression.
The GetCostAndUsageWithResources
operation requires that you either group by or filter by a
ResourceId
. It requires the Expression
"SERVICE = Amazon Elastic Compute Cloud - Compute"
in the filter.
Valid values for MatchOptions
for Dimensions
are EQUALS
and
CASE_SENSITIVE
.
Valid values for MatchOptions
for CostCategories
and Tags
are
EQUALS
, ABSENT
, and CASE_SENSITIVE
. Default values are EQUALS
and CASE_SENSITIVE
.
List<E> metrics
Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.
Valid values are AmortizedCost
, BlendedCost
, NetAmortizedCost
,
NetUnblendedCost
, NormalizedUsageAmount
, UnblendedCost
, and
UsageQuantity
.
If you return the UsageQuantity
metric, the service aggregates all usage numbers without taking the
units into account. For example, if you aggregate usageQuantity
across all of Amazon EC2, the
results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for
example, hour or GB). To get more meaningful UsageQuantity
metrics, filter by UsageType
or UsageTypeGroups
.
Metrics
is required for GetCostAndUsageWithResources
requests.
List<E> groupBy
You can group Amazon Web Services costs using up to two different groups: DIMENSION
,
TAG
, COST_CATEGORY
.
String nextPageToken
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.
String nextPageToken
The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
List<E> groupDefinitions
The groups that are specified by the Filter
or GroupBy
parameters in the request.
List<E> resultsByTime
The time period that's covered by the results in the response.
List<E> dimensionValueAttributes
The attributes that apply to a specific dimension value. For example, if the value is a linked account, the attribute is that account name.
String searchString
The value that you want to search the filter values for.
If you don't specify a CostCategoryName
, SearchString
is used to filter Cost Category
names that match the SearchString
pattern. If you specify a CostCategoryName
,
SearchString
is used to filter Cost Category values that match the SearchString
pattern.
DateInterval timePeriod
String costCategoryName
Expression filter
List<E> sortBy
The value that you sort the data by.
The key represents the cost and usage metrics. The following values are supported:
BlendedCost
UnblendedCost
AmortizedCost
NetAmortizedCost
NetUnblendedCost
UsageQuantity
NormalizedUsageAmount
The supported key values for the SortOrder
value are ASCENDING
and
DESCENDING
.
When you use the SortBy
value, the NextPageToken
and SearchString
key
values aren't supported.
Integer maxResults
This field is only used when the SortBy
value is provided in the request.
The maximum number of objects that are returned for this request. If MaxResults
isn't specified with
the SortBy
value, the request returns 1000 results as the default value for this parameter.
For GetCostCategories
, MaxResults has an upper quota of 1000.
String nextPageToken
If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the previous call in your next request.
String nextPageToken
If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
List<E> costCategoryNames
The names of the Cost Categories.
List<E> costCategoryValues
The Cost Category values.
If the CostCategoryName
key isn't specified in the request, the CostCategoryValues
fields aren't returned.
Integer returnSize
The number of objects that are returned.
Integer totalSize
The total number of objects.
DateInterval timePeriod
The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.
String metric
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
String granularity
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.
Expression filter
The filters that you want to use to filter your forecast. The GetCostForecast
API supports filtering
by the following dimensions:
AZ
INSTANCE_TYPE
LINKED_ACCOUNT
LINKED_ACCOUNT_NAME
OPERATION
PURCHASE_TYPE
REGION
SERVICE
USAGE_TYPE
USAGE_TYPE_GROUP
RECORD_TYPE
OPERATING_SYSTEM
TENANCY
SCOPE
PLATFORM
SUBSCRIPTION_ID
LEGAL_ENTITY_NAME
DEPLOYMENT_OPTION
DATABASE_ENGINE
INSTANCE_TYPE_FAMILY
BILLING_ENTITY
RESERVATION_ID
SAVINGS_PLAN_ARN
Integer predictionIntervalLevel
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.
MetricValue total
How much you are forecasted to spend over the forecast period, in USD
.
List<E> forecastResultsByTime
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.
String searchString
The value that you want to search the filter values for.
DateInterval timePeriod
The start date and end date for retrieving the dimension values. The start date is inclusive, but the end date is
exclusive. For example, if start
is 2017-01-01
and end
is
2017-05-01
, then the cost and usage data is retrieved from 2017-01-01
up to and
including 2017-04-30
but not including 2017-05-01
.
String dimension
The name of the dimension. Each Dimension
is available for a different Context
. For
more information, see Context
. LINK_ACCOUNT_NAME
and SERVICE_CODE
can only
be used in CostCategoryRule.
String 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
.
BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:
- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.
- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services in India.
- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on Amazon Web Services by third-party software providers.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
SingleAZ
and MultiAZ
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge
.
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are
Compute Optimized
(for example, C4
, C5
, C6g
, and
C7g
), Memory Optimization
(for example, R4
, R5n
,
R5b
, and R6g
).
INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services invoice.
LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance
and CreateBucket
.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase that this usage is related to. Examples include On-Demand Instances and Standard Reserved Instances.
RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
GetDimensionValues
operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
REGION - The Amazon Web Services Region.
RECORD_TYPE - The different types of charges such as Reserved Instance (RI) fees, usage costs, tax refunds, and credits.
RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.
If you set the context to RESERVATIONS
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
SingleAZ
and MultiAZ
.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge
.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
REGION - The Amazon Web Services Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
If you set the context to SAVINGS_PLANS
, you can use the following dimensions for searching:
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
PAYMENT_OPTION - The payment option for the given Savings Plans (for example, All Upfront)
REGION - The Amazon Web Services Region.
INSTANCE_TYPE_FAMILY - The family of instances (For example, m5
)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
Expression filter
List<E> sortBy
The value that you want to sort the data by.
The key represents cost and usage metrics. The following values are supported:
BlendedCost
UnblendedCost
AmortizedCost
NetAmortizedCost
NetUnblendedCost
UsageQuantity
NormalizedUsageAmount
The supported values for the SortOrder
key are ASCENDING
or DESCENDING
.
When you specify a SortBy
paramater, the context must be COST_AND_USAGE
. Further, when
using SortBy
, NextPageToken
and SearchString
aren't supported.
Integer maxResults
This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.
For GetDimensionValues
, MaxResults has an upper limit of 1000.
String nextPageToken
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.
List<E> dimensionValues
The filters that you used to filter your request. Some dimensions are available only for a specific context.
If you set the context to COST_AND_USAGE
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge
.
LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance
and CreateBucket
.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
GetDimensionValues
operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14
days for EC2-Compute Service. You can opt-in by enabling Hourly
and Resource Level Data
in Cost Management Console preferences.
If you set the context to RESERVATIONS
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
SingleAZ
and MultiAZ
.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge
.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
REGION - The Amazon Web Services Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
If you set the context to SAVINGS_PLANS
, you can use the following dimensions for searching:
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
REGION - The Amazon Web Services Region.
INSTANCE_TYPE_FAMILY - The family of instances (For example, m5
)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
Integer returnSize
The number of results that Amazon Web Services returned at one time.
Integer totalSize
The total number of search results.
String nextPageToken
The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
DateInterval timePeriod
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
.
List<E> groupBy
You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
INVOICING_ENTITY
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TENANCY
String granularity
The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY
and DAILY
.
If GroupBy
is set, Granularity
can't be set. If Granularity
isn't set, the
response object doesn't include Granularity
, either MONTHLY
or DAILY
.
The GetReservationCoverage
operation supports only DAILY
and MONTHLY
granularities.
Expression filter
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
GetReservationCoverage
uses the same Expression
object as the other operations, but only AND
is supported among each dimension. You can nest only
one level deep. If there are multiple values for a dimension, they are OR'd together.
If you don't provide a SERVICE
filter, Cost Explorer defaults to EC2.
Cost category is also supported.
List<E> metrics
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.
String nextPageToken
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.
SortDefinition sortBy
The value by which you want to sort the data.
The following values are supported for Key
:
OnDemandCost
CoverageHoursPercentage
OnDemandHours
ReservedHours
TotalRunningHours
CoverageNormalizedUnitsPercentage
OnDemandNormalizedUnits
ReservedNormalizedUnits
TotalRunningNormalizedUnits
Time
Supported values for SortOrder
are ASCENDING
or DESCENDING
.
Integer maxResults
The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
List<E> coveragesByTime
The amount of time that your reservations covered.
Coverage total
The total amount of instance usage that a reservation covered.
String nextPageToken
The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
String accountId
The account ID that's associated with the recommendation.
String service
The specific service that you want recommendations for.
Expression filter
String accountScope
The account scope that you want your recommendations for. Amazon Web Services calculates recommendations
including the management account and member accounts if the value is set to PAYER
. If the value is
LINKED
, recommendations are calculated for individual member accounts only.
String lookbackPeriodInDays
The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.
String termInYears
The reservation term that you want recommendations for.
String paymentOption
The reservation purchase option that you want recommendations for.
ServiceSpecification serviceSpecification
The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.
Integer pageSize
The number of recommendations that you want returned in a single response object.
String nextPageToken
The pagination token that indicates the next set of results that you want to retrieve.
ReservationPurchaseRecommendationMetadata metadata
Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.
List<E> recommendations
Recommendations for reservations to purchase.
String nextPageToken
The pagination token for the next set of retrievable results.
DateInterval timePeriod
Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but
the end date is exclusive. For example, if start
is 2017-01-01
and end
is
2017-05-01
, then the cost and usage data is retrieved from 2017-01-01
up to and
including 2017-04-30
but not including 2017-05-01
.
List<E> groupBy
Groups only by SUBSCRIPTION_ID
. Metadata is included.
String granularity
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.
Expression filter
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.
SortDefinition sortBy
The value that you want to sort the data by.
The following values are supported for Key
:
UtilizationPercentage
UtilizationPercentageInUnits
PurchasedHours
PurchasedUnits
TotalActualHours
TotalActualUnits
UnusedHours
UnusedUnits
OnDemandCostOfRIHoursUsed
NetRISavings
TotalPotentialRISavings
AmortizedUpfrontFee
AmortizedRecurringFee
TotalAmortizedFee
RICostForUnusedHours
RealizedSavings
UnrealizedSavings
The supported values for SortOrder
are ASCENDING
and DESCENDING
.
String nextPageToken
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.
Integer maxResults
The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
List<E> utilizationsByTime
The amount of time that you used your Reserved Instances (RIs).
ReservationAggregates total
The total amount of time that you used your Reserved Instances (RIs).
String nextPageToken
The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
Expression filter
RightsizingRecommendationConfiguration configuration
You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.
String service
The specific service that you want recommendations for. The only valid value for
GetRightsizingRecommendation
is "AmazonEC2
".
Integer pageSize
The number of recommendations that you want returned in a single response object.
String nextPageToken
The pagination token that indicates the next set of results that you want to retrieve.
RightsizingRecommendationMetadata metadata
Information regarding this specific recommendation set.
RightsizingRecommendationSummary summary
Summary of this recommendation set.
List<E> rightsizingRecommendations
Recommendations to rightsize resources.
String nextPageToken
The token to retrieve the next set of results.
RightsizingRecommendationConfiguration configuration
You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.
String recommendationDetailId
The ID that is associated with the Savings Plan recommendation.
String recommendationDetailId
The ID that is associated with the Savings Plan recommendation.
RecommendationDetailData recommendationDetailData
Contains detailed information about a specific Savings Plan recommendation.
DateInterval timePeriod
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.
List<E> groupBy
You can group the data using the attributes INSTANCE_FAMILY
, REGION
, or
SERVICE
.
String granularity
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.
Expression filter
Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:
LINKED_ACCOUNT
REGION
SERVICE
INSTANCE_FAMILY
GetSavingsPlansCoverage
uses the same Expression
object as the other operations, but only AND
is supported among each dimension. If there are
multiple values for a dimension, they are OR'd together.
Cost category is also supported.
List<E> metrics
The measurement that you want your Savings Plans coverage reported in. The only valid value is
SpendCoveredBySavingsPlans
.
String nextToken
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.
Integer maxResults
The number of items to be returned in a response. The default is 20
, with a minimum value of
1
.
SortDefinition sortBy
The value that you want to sort the data by.
The following values are supported for Key
:
SpendCoveredBySavingsPlan
OnDemandCost
CoveragePercentage
TotalCost
InstanceFamily
Region
Service
The supported values for SortOrder
are ASCENDING
and DESCENDING
.
List<E> savingsPlansCoverages
The amount of spend that your Savings Plans covered.
String nextToken
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.
String savingsPlansType
The Savings Plans recommendation type that's requested.
String termInYears
The savings plan recommendation term that's used to generate these recommendations.
String paymentOption
The payment option that's used to generate these recommendations.
String accountScope
The account scope that you want your recommendations for. Amazon Web Services calculates recommendations
including the management account and member accounts if the value is set to PAYER
. If the value is
LINKED
, recommendations are calculated for individual member accounts only.
String nextPageToken
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.
Integer pageSize
The number of recommendations that you want returned in a single response object.
String lookbackPeriodInDays
The lookback period that's used to generate the recommendation.
Expression filter
You can filter your recommendations by Account ID with the LINKED_ACCOUNT
dimension. To filter your
recommendations by Account ID, specify Key
as LINKED_ACCOUNT
and Value
as
the comma-separated Acount ID(s) that you want to see Savings Plans purchase recommendations for.
For GetSavingsPlansPurchaseRecommendation, the Filter
doesn't include CostCategories
or
Tags
. It only includes Dimensions
. With Dimensions
, Key
must
be LINKED_ACCOUNT
and Value
can be a single Account ID or multiple comma-separated
Account IDs that you want to see Savings Plans Purchase Recommendations for. AND
and OR
operators are not supported.
SavingsPlansPurchaseRecommendationMetadata metadata
Information that regards this specific recommendation set.
SavingsPlansPurchaseRecommendation savingsPlansPurchaseRecommendation
Contains your request parameters, Savings Plan Recommendations Summary, and Details.
String nextPageToken
The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
DateInterval timePeriod
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.
Expression filter
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.
List<E> dataType
The data type.
String nextToken
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.
Integer maxResults
The number of items to be returned in a response. The default is 20
, with a minimum value of
1
.
SortDefinition sortBy
The value that you want to sort the data by.
The following values are supported for Key
:
UtilizationPercentage
TotalCommitment
UsedCommitment
UnusedCommitment
NetSavings
AmortizedRecurringCommitment
AmortizedUpfrontCommitment
The supported values for SortOrder
are ASCENDING
and DESCENDING
.
List<E> savingsPlansUtilizationDetails
Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.
SavingsPlansUtilizationAggregates total
The total Savings Plans utilization, regardless of time period.
DateInterval timePeriod
String nextToken
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.
DateInterval timePeriod
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.
String granularity
The granularity of the Amazon Web Services utillization data for your Savings Plans.
The GetSavingsPlansUtilization
operation supports only DAILY
and MONTHLY
granularities.
Expression filter
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.
SortDefinition sortBy
The value that you want to sort the data by.
The following values are supported for Key
:
UtilizationPercentage
TotalCommitment
UsedCommitment
UnusedCommitment
NetSavings
The supported values for SortOrder
are ASCENDING
and DESCENDING
.
List<E> savingsPlansUtilizationsByTime
The amount of cost/commitment that you used your Savings Plans. You can use it to specify date ranges.
SavingsPlansUtilizationAggregates total
The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.
String searchString
The value that you want to search for.
DateInterval timePeriod
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
.
String tagKey
The key of the tag that you want to return values for.
Expression filter
List<E> sortBy
The value that you want to sort the data by.
The key represents cost and usage metrics. The following values are supported:
BlendedCost
UnblendedCost
AmortizedCost
NetAmortizedCost
NetUnblendedCost
UsageQuantity
NormalizedUsageAmount
The supported values for SortOrder
are ASCENDING
and DESCENDING
.
When you use SortBy
, NextPageToken
and SearchString
aren't supported.
Integer maxResults
This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.
For GetTags
, MaxResults has an upper quota of 1000.
String nextPageToken
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.
String nextPageToken
The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
List<E> tags
The tags that match your request.
Integer returnSize
The number of query results that Amazon Web Services returns at a time.
Integer totalSize
The total number of query results.
DateInterval timePeriod
The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in
the period, but the end date isn't included in the period. For example, if start
is
2017-01-01
and end
is 2017-05-01
, then the cost and usage data is
retrieved from 2017-01-01
up to and including 2017-04-30
but not including
2017-05-01
. The start date must be equal to or later than the current date to avoid a validation
error.
String metric
Which metric Cost Explorer uses to create your forecast.
Valid values for a GetUsageForecast
call are the following:
USAGE_QUANTITY
NORMALIZED_USAGE_AMOUNT
String granularity
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.
Expression filter
The filters that you want to use to filter your forecast. The GetUsageForecast
API supports
filtering by the following dimensions:
AZ
INSTANCE_TYPE
LINKED_ACCOUNT
LINKED_ACCOUNT_NAME
OPERATION
PURCHASE_TYPE
REGION
SERVICE
USAGE_TYPE
USAGE_TYPE_GROUP
RECORD_TYPE
OPERATING_SYSTEM
TENANCY
SCOPE
PLATFORM
SUBSCRIPTION_ID
LEGAL_ENTITY_NAME
DEPLOYMENT_OPTION
DATABASE_ENGINE
INSTANCE_TYPE_FAMILY
BILLING_ENTITY
RESERVATION_ID
SAVINGS_PLAN_ARN
Integer predictionIntervalLevel
Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
MetricValue total
How much you're forecasted to use over the forecast period.
List<E> forecastResultsByTime
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.
Double maxImpact
The maximum dollar value that's observed for an anomaly.
Double totalImpact
The cumulative dollar difference between the total actual spend and total expected spend. It is calculated as
TotalActualSpend - TotalExpectedSpend
.
Double totalActualSpend
The cumulative dollar amount that was actually spent during the anomaly.
Double totalExpectedSpend
The cumulative dollar amount that was expected to be spent during the anomaly. It is calculated using advanced machine learning models to determine the typical spending pattern based on historical data for a customer.
Double totalImpactPercentage
The cumulative percentage difference between the total actual spend and total expected spend. It is calculated as
(TotalImpact / TotalExpectedSpend) * 100
. When TotalExpectedSpend
is zero, this field
is omitted. Expected spend can be zero in situations such as when you start to use a service for the first time.
EC2InstanceDetails eC2InstanceDetails
The Amazon EC2 reservations that Amazon Web Services recommends that you purchase.
RDSInstanceDetails rDSInstanceDetails
The Amazon RDS reservations that Amazon Web Services recommends that you purchase.
RedshiftInstanceDetails redshiftInstanceDetails
The Amazon Redshift reservations that Amazon Web Services recommends that you purchase.
ElastiCacheInstanceDetails elastiCacheInstanceDetails
The ElastiCache reservations that Amazon Web Services recommends that you purchase.
ESInstanceDetails eSInstanceDetails
The Amazon OpenSearch Service reservations that Amazon Web Services recommends that you purchase.
MemoryDBInstanceDetails memoryDBInstanceDetails
The MemoryDB reservations that Amazon Web Services recommends that you purchase.
String status
The status of cost allocation tag keys that are returned for this request.
List<E> tagKeys
The list of cost allocation tag keys that are returned for this request.
String type
The type of CostAllocationTag
object that are returned for this request. The
AWSGenerated
type tags are tags that Amazon Web Services defines and applies to support Amazon Web
Services resources for cost allocation purposes. The UserDefined
type tags are tags that you define,
create, and apply to resources.
String nextToken
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.
Integer maxResults
The maximum number of objects that are returned for this request. By default, the request returns 100 results.
List<E> costAllocationTags
A list of cost allocation tags that includes the detailed metadata for each one.
String nextToken
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.
String effectiveOn
The date when the Cost Category was effective.
String nextToken
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.
Integer maxResults
The number of entries a paginated response contains.
List<E> costCategoryReferences
A reference to a Cost Category that contains enough information to identify the Cost Category.
String nextToken
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.
String generationStatus
The status of the recommendation generation.
List<E> recommendationIds
The IDs for each specific recommendation.
Integer pageSize
The number of recommendations that you want returned in a single response object.
String nextPageToken
The token to retrieve the next set of results.
String resourceArn
The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag.
String family
The instance family of the recommended reservation.
String nodeType
The node type of the recommended reservation.
String region
The Amazon Web Services Region of the recommended reservation.
Boolean currentGeneration
Determines whether the recommendation is for a current generation instance.
Boolean sizeFlexEligible
Determines whether the recommended reservation is size flexible.
String networkInBytesPerSecond
The network inbound throughput utilization measured in Bytes per second (Bps).
String networkOutBytesPerSecond
The network outbound throughput utilization measured in Bytes per second (Bps).
String networkPacketsInPerSecond
The network inbound packets that are measured in packets per second.
String networkPacketsOutPerSecond
The network outbound packets that are measured in packets per second.
String anomalyId
The ID of the modified cost anomaly.
String family
The instance family of the recommended reservation.
String instanceType
The type of instance that Amazon Web Services recommends.
String region
The Amazon Web Services Region of the recommended reservation.
String databaseEngine
The database engine that the recommended reservation supports.
String databaseEdition
The database edition that the recommended reservation supports.
String deploymentOption
Determines whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.
String licenseModel
The license model that the recommended reservation supports.
Boolean currentGeneration
Determines whether the recommendation is for a current-generation instance.
Boolean sizeFlexEligible
Determines whether the recommended reservation is size flexible.
String accountScope
The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
String lookbackPeriodInDays
How many days of previous usage that Amazon Web Services considers when making this recommendation.
String savingsPlansType
The requested Savings Plan recommendation type.
String termInYears
The term of the commitment in years.
String paymentOption
The payment option for the commitment (for example, All Upfront or No Upfront).
String accountId
The AccountID that the recommendation is generated for.
String currencyCode
The currency code that Amazon Web Services used to generate the recommendation and present potential savings.
String instanceFamily
The instance family of the recommended Savings Plan.
String region
The region the recommendation is generated for.
String offeringId
The unique ID that's used to distinguish Savings Plans from one another.
String generationTimestamp
String latestUsageTimestamp
String currentAverageHourlyOnDemandSpend
The average value of hourly On-Demand spend over the lookback period of the applicable usage type.
String currentMaximumHourlyOnDemandSpend
The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.
String currentMinimumHourlyOnDemandSpend
The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.
String estimatedAverageUtilization
The estimated utilization of the recommended Savings Plan.
String estimatedMonthlySavingsAmount
The estimated monthly savings amount based on the recommended Savings Plan.
String estimatedOnDemandCost
The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.
String estimatedOnDemandCostWithCurrentCommitment
The estimated On-Demand costs you expect with no additional commitment, based on your usage of the selected time period and the Savings Plan you own.
String estimatedROI
The estimated return on investment that's based on the recommended Savings Plan that you purchased. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.
String estimatedSPCost
The cost of the recommended Savings Plan over the length of the lookback period.
String estimatedSavingsAmount
The estimated savings amount that's based on the recommended Savings Plan over the length of the lookback period.
String estimatedSavingsPercentage
The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.
String existingHourlyCommitment
The existing hourly commitment for the Savings Plan type.
String hourlyCommitmentToPurchase
The recommended hourly commitment level for the Savings Plan type and the configuration that's based on the usage during the lookback period.
String upfrontCost
The upfront cost of the recommended Savings Plan, based on the selected payment option.
String currentAverageCoverage
The average value of hourly coverage over the lookback period.
String estimatedAverageCoverage
The estimated coverage of the recommended Savings Plan.
List<E> metricsOverLookbackPeriod
The related hourly cost, coverage, and utilization metrics over the lookback period.
String startTime
String estimatedOnDemandCost
The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.
String currentCoverage
The current amount of Savings Plans eligible usage that the Savings Plan covered.
String estimatedCoverage
The estimated coverage amount based on the recommended Savings Plan.
String estimatedNewCommitmentUtilization
The estimated utilization for the recommended Savings Plan.
String family
The instance family of the recommended reservation.
String nodeType
The type of node that Amazon Web Services recommends.
String region
The Amazon Web Services Region of the recommended reservation.
Boolean currentGeneration
Determines whether the recommendation is for a current-generation instance.
Boolean sizeFlexEligible
Determines whether the recommended reservation is size flexible.
String utilizationPercentage
The percentage of reservation time that you used.
String utilizationPercentageInUnits
The percentage of Amazon EC2 reservation time that you used. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
String purchasedHours
How many reservation hours that you purchased.
String purchasedUnits
The number of Amazon EC2 reservation hours that you purchased. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
String totalActualHours
The total number of reservation hours that you used.
String totalActualUnits
The total number of Amazon EC2 reservation hours that you used. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
String unusedHours
The number of reservation hours that you didn't use.
String unusedUnits
The number of Amazon EC2 reservation hours that you didn't use. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
String onDemandCostOfRIHoursUsed
How much your reservation costs if charged On-Demand rates.
String netRISavings
How much you saved due to purchasing and utilizing reservation. Amazon Web Services calculates this by
subtracting TotalAmortizedFee
from OnDemandCostOfRIHoursUsed
.
String totalPotentialRISavings
How much you might save if you use your entire reservation.
String amortizedUpfrontFee
The upfront cost of your reservation. It's amortized over the reservation period.
String amortizedRecurringFee
The monthly cost of your reservation. It's amortized over the reservation period.
String totalAmortizedFee
The total cost of your reservation. It's amortized over the reservation period.
String rICostForUnusedHours
The cost of unused hours for your reservation.
String realizedSavings
The realized savings because of purchasing and using a reservation.
String unrealizedSavings
The unrealized savings because of purchasing and using a reservation.
String accountScope
The account scope that Amazon Web Services recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in Amazon Web Services Organizations.
String lookbackPeriodInDays
How many days of previous usage that Amazon Web Services considers when making this recommendation.
String termInYears
The term of the reservation that you want recommendations for, in years.
String paymentOption
The payment option for the reservation (for example, AllUpfront
or NoUpfront
).
ServiceSpecification serviceSpecification
Hardware specifications for the service that you want recommendations for.
List<E> recommendationDetails
Details about the recommended purchases.
ReservationPurchaseRecommendationSummary recommendationSummary
A summary about the recommended purchase.
String accountId
The account that this Reserved Instance (RI) recommendation is for.
InstanceDetails instanceDetails
Details about the reservations that Amazon Web Services recommends that you purchase.
String recommendedNumberOfInstancesToPurchase
The number of instances that Amazon Web Services recommends that you purchase.
String recommendedNormalizedUnitsToPurchase
The number of normalized units that Amazon Web Services recommends that you purchase.
String minimumNumberOfInstancesUsedPerHour
The minimum number of instances that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.
String minimumNormalizedUnitsUsedPerHour
The minimum number of normalized units that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.
String maximumNumberOfInstancesUsedPerHour
The maximum number of instances that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.
String maximumNormalizedUnitsUsedPerHour
The maximum number of normalized units that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.
String averageNumberOfInstancesUsedPerHour
The average number of instances that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.
String averageNormalizedUnitsUsedPerHour
The average number of normalized units that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.
String averageUtilization
The average utilization of your instances. Amazon Web Services uses this to calculate your recommended reservation purchases.
String estimatedBreakEvenInMonths
How long Amazon Web Services estimates that it takes for this instance to start saving you money, in months.
String currencyCode
The currency code that Amazon Web Services used to calculate the costs for this instance.
String estimatedMonthlySavingsAmount
How much Amazon Web Services estimates that this specific recommendation might save you in a month.
String estimatedMonthlySavingsPercentage
How much Amazon Web Services estimates that this specific recommendation might save you in a month, as a percentage of your overall costs.
String estimatedMonthlyOnDemandCost
How much Amazon Web Services estimates that you spend on On-Demand Instances in a month.
String estimatedReservationCostForLookbackPeriod
How much Amazon Web Services estimates that you might spend for all usage during the specified historical period if you had a reservation.
String upfrontCost
How much purchasing this instance costs you upfront.
String recurringStandardMonthlyCost
How much purchasing this instance costs you on a monthly basis.
String totalEstimatedMonthlySavingsAmount
The total amount that Amazon Web Services estimates that this recommendation could save you in a month.
String totalEstimatedMonthlySavingsPercentage
The total amount that Amazon Web Services estimates that this recommendation could save you in a month, as a percentage of your costs.
String currencyCode
The currency code used for this recommendation.
EC2ResourceDetails eC2ResourceDetails
Details for the Amazon EC2 resource.
String resourceName
EC2ResourceUtilization eC2ResourceUtilization
The utilization of current Amazon EC2 instance.
String accountId
The account that this recommendation is for.
CurrentInstance currentInstance
Context regarding the current instance.
String rightsizingType
A recommendation to either terminate or modify the resource.
ModifyRecommendationDetail modifyRecommendationDetail
The details for the modification recommendations.
TerminateRecommendationDetail terminateRecommendationDetail
The details for termination recommendations.
List<E> findingReasonCodes
The list of possible reasons why the recommendation is generated, such as under- or over-utilization of specific metrics (for example, CPU, Memory, Network).
String recommendationTarget
The option to see recommendations within the same instance family or recommendations for instances across other
families. The default value is SAME_INSTANCE_FAMILY
.
Boolean benefitsConsidered
The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is
TRUE
.
String recommendationId
The ID for this specific recommendation.
String generationTimestamp
The timestamp for when Amazon Web Services made this recommendation.
String lookbackPeriodInDays
The number of days of previous usage that Amazon Web Services considers when making this recommendation.
String additionalMetadata
Additional metadata that might be applicable to the recommendation.
String totalRecommendationCount
The total number of instance recommendations.
String estimatedTotalMonthlySavingsAmount
The estimated total savings resulting from modifications, on a monthly basis.
String savingsCurrencyCode
The currency code that Amazon Web Services used to calculate the savings.
String savingsPercentage
The savings percentage based on the recommended modifications. It's relative to the total On-Demand costs that are associated with these instances.
String service
The Amazon Web Service name that's associated with the cost anomaly.
String region
The Amazon Web Services Region that's associated with the cost anomaly.
String linkedAccount
The member account value that's associated with the cost anomaly.
String usageType
The UsageType
value that's associated with the cost anomaly.
String linkedAccountName
The member account name value that's associated with the cost anomaly.
String amortizedRecurringCommitment
The amortized amount of your Savings Plans commitment that was purchased with either a Partial
or a
NoUpfront
.
String amortizedUpfrontCommitment
The amortized amount of your Savings Plans commitment that was purchased with an Upfront
or
PartialUpfront
Savings Plans.
String totalAmortizedCommitment
The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.
Map<K,V> attributes
The attribute that applies to a specific Dimension
.
SavingsPlansCoverageData coverage
The amount of Savings Plans eligible usage that the Savings Plans covered.
DateInterval timePeriod
String spendCoveredBySavingsPlans
The amount of your Amazon Web Services usage that's covered by a Savings Plans.
String onDemandCost
The cost of your Amazon Web Services usage at the public On-Demand rate.
String totalCost
The total cost of your Amazon Web Services usage, regardless of your purchase option.
String coveragePercentage
The percentage of your existing Savings Plans covered usage, divided by all of your eligible Savings Plans usage in an account (or set of accounts).
String region
A collection of Amazon Web Services resources in a geographic area. Each Amazon Web Services Region is isolated and independent of the other Regions.
String instanceFamily
A group of instance types that Savings Plans applies to.
String offeringId
The unique ID that's used to distinguish Savings Plans from one another.
String accountScope
The account scope that you want your recommendations for. Amazon Web Services calculates recommendations that
include the management account and member accounts if the value is set to PAYER
. If the value is
LINKED
, recommendations are calculated for individual member accounts only.
String savingsPlansType
The requested Savings Plans recommendation type.
String termInYears
The Savings Plans recommendation term in years. It's used to generate the recommendation.
String paymentOption
The payment option that's used to generate the recommendation.
String lookbackPeriodInDays
The lookback period in days that's used to generate the recommendation.
List<E> savingsPlansPurchaseRecommendationDetails
Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible workloads.
SavingsPlansPurchaseRecommendationSummary savingsPlansPurchaseRecommendationSummary
Summary metrics for your Savings Plans Recommendations.
SavingsPlansDetails savingsPlansDetails
Details for your recommended Savings Plans.
String accountId
The AccountID
the recommendation is generated for.
String upfrontCost
The upfront cost of the recommended Savings Plans, based on the selected payment option.
String estimatedROI
The estimated return on investment that's based on the recommended Savings Plans that you purchased. This is
calculated as estimatedSavingsAmount
/ estimatedSPCost
*100.
String currencyCode
The currency code that Amazon Web Services used to generate the recommendations and present potential savings.
String estimatedSPCost
The cost of the recommended Savings Plans over the length of the lookback period.
String estimatedOnDemandCost
The remaining On-Demand cost estimated to not be covered by the recommended Savings Plans, over the length of the lookback period.
String estimatedOnDemandCostWithCurrentCommitment
The estimated On-Demand costs you expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own.
String estimatedSavingsAmount
The estimated savings amount that's based on the recommended Savings Plans over the length of the lookback period.
String estimatedSavingsPercentage
The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.
String hourlyCommitmentToPurchase
The recommended hourly commitment level for the Savings Plans type and the configuration that's based on the usage during the lookback period.
String estimatedAverageUtilization
The estimated utilization of the recommended Savings Plans.
String estimatedMonthlySavingsAmount
The estimated monthly savings amount based on the recommended Savings Plans.
String currentMinimumHourlyOnDemandSpend
The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.
String currentMaximumHourlyOnDemandSpend
The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.
String currentAverageHourlyOnDemandSpend
The average value of hourly On-Demand spend over the lookback period of the applicable usage type.
String recommendationDetailId
Contains detailed information about a specific Savings Plan recommendation.
String recommendationId
The unique identifier for the recommendation set.
String generationTimestamp
The timestamp that shows when the recommendations were generated.
String additionalMetadata
Additional metadata that might be applicable to the recommendation.
String estimatedROI
The estimated return on investment that's based on the recommended Savings Plans and estimated savings.
String currencyCode
The currency code that Amazon Web Services used to generate the recommendations and present potential savings.
String estimatedTotalCost
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.
String currentOnDemandSpend
The current total on demand spend of the applicable usage types over the lookback period.
String estimatedSavingsAmount
The estimated total savings over the lookback period, based on the purchase of the recommended Savings Plans.
String totalRecommendationCount
The aggregate number of Savings Plans recommendations that exist for your account.
String dailyCommitmentToPurchase
The recommended Savings Plans cost on a daily (24 hourly) basis.
String hourlyCommitmentToPurchase
The recommended hourly commitment that's based on the recommendation parameters.
String estimatedSavingsPercentage
The estimated savings relative to the total cost of On-Demand usage, over the lookback period. This is calculated
as estimatedSavingsAmount
/ CurrentOnDemandSpend
*100.
String estimatedMonthlySavingsAmount
The estimated monthly savings amount that's based on the recommended Savings Plans purchase.
String estimatedOnDemandCostWithCurrentCommitment
The estimated On-Demand costs you expect with no additional commitment. It's based on your usage of the selected time period and the Savings Plans you own.
String netSavings
The savings amount that you're accumulating for the usage that's covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.
String onDemandCostEquivalent
How much the amount that the usage would have cost if it was accrued at the On-Demand rate.
String totalCommitment
The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).
String usedCommitment
The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.
String unusedCommitment
The amount of your Savings Plans commitment that wasn't consumed from Savings Plans eligible usage in a specific period.
String utilizationPercentage
The amount of UsedCommitment
divided by the TotalCommitment
for your Savings Plans.
SavingsPlansUtilization utilization
A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.
SavingsPlansSavings savings
The amount that's saved by using existing Savings Plans. Savings returns both net savings from Savings Plans and
also the onDemandCostEquivalent
of the Savings Plans when considering the utilization rate.
SavingsPlansAmortizedCommitment amortizedCommitment
The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.
DateInterval timePeriod
SavingsPlansUtilization utilization
A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.
SavingsPlansSavings savings
The amount that's saved by using existing Savings Plans. Savings returns both net savings from Savings Plans and
also the onDemandCostEquivalent
of the Savings Plans when considering the utilization rate.
SavingsPlansAmortizedCommitment amortizedCommitment
The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.
String savingsPlanArn
The unique Amazon Resource Name (ARN) for a particular Savings Plan.
Map<K,V> attributes
The attribute that applies to a specific Dimension
.
SavingsPlansUtilization utilization
A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.
SavingsPlansSavings savings
The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans and also
the onDemandCostEquivalent
of the Savings Plans when considering the utilization rate.
SavingsPlansAmortizedCommitment amortizedCommitment
The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings Plans fees.
EC2Specification eC2Specification
The Amazon EC2 hardware specifications that you want Amazon Web Services to provide recommendations for.
String recommendationId
The ID for this specific recommendation.
String generationStartedTime
The start time of the recommendation generation.
String estimatedCompletionTime
The estimated time for when the recommendation generation will complete.
String resourceArn
The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag.
List<E> resourceTags
A list of tag key-value pairs to be added to the resource.
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use
The maximum length of a key is 128 characters
The maximum length of a value is 256 characters
Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-
Keys and values are case sensitive
Keys and values are trimmed for any leading or trailing whitespaces
Don’t use aws:
as a prefix for your keys. This prefix is reserved for Amazon Web Services use
String key
The key for the tag.
List<E> values
The specific value of the tag.
List<E> matchOptions
The match options that you can use to filter your results. MatchOptions
is only applicable for
actions related to Cost Category. The default values for MatchOptions
are EQUALS
and
CASE_SENSITIVE
.
String estimatedMonthlyCost
The expected cost to operate this instance type on a monthly basis.
String estimatedMonthlySavings
The estimated savings that result from modification, on a monthly basis.
String currencyCode
The currency code that Amazon Web Services used to calculate the costs for this instance.
Boolean defaultTargetInstance
Determines whether this recommendation is the defaulted Amazon Web Services recommendation.
ResourceDetails resourceDetails
Details on the target instance type.
ResourceUtilization expectedResourceUtilization
The expected utilization metrics for target instance type.
List<E> platformDifferences
Explains the actions that you might need to take to successfully migrate your workloads from the current instance type to the recommended instance type.
String resourceName
String resourceArn
The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag.
List<E> resourceTagKeys
A list of tag keys associated with tags that need to be removed from the resource. If you specify a tag key that doesn't exist, it's ignored. Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.
String monitorArn
A cost anomaly monitor ARN.
String subscriptionArn
A cost anomaly subscription Amazon Resource Name (ARN).
Double threshold
(deprecated)
The update to the threshold value for receiving notifications.
This field has been deprecated. To update a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.
You can specify either Threshold or ThresholdExpression, but not both.
String frequency
The update to the frequency value that subscribers receive notifications.
List<E> monitorArnList
A list of cost anomaly monitor ARNs.
List<E> subscribers
The update to the subscriber list.
String subscriptionName
The new name of the subscription.
Expression thresholdExpression
The update to the Expression
object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested
expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE
and
ANOMALY_TOTAL_IMPACT_PERCENTAGE
, corresponding to an anomaly’s TotalImpact and
TotalImpactPercentage, respectively (see Impact for more
details). The supported nested expression types are AND
and OR
. The match option
GREATER_THAN_OR_EQUAL
is required. Values must be numbers between 0 and 10,000,000,000 in string
format.
You can specify either Threshold or ThresholdExpression, but not both.
The following are examples of valid ThresholdExpressions:
Absolute threshold:
{ "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }
Percentage threshold:
{ "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }
AND
two thresholds together:
{ "And": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }
OR
two thresholds together:
{ "Or": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }
String subscriptionArn
A cost anomaly subscription ARN.
String costCategoryArn
The unique identifier for your Cost Category.
String effectiveStart
The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.
String ruleVersion
List<E> rules
The Expression
object used to categorize costs. For more information, see CostCategoryRule .
String defaultValue
List<E> splitChargeRules
The split charge rules used to allocate your charges between your Cost Category values.
DateInterval timePeriod
The period of time that this utilization was used for.
List<E> groups
The groups that this utilization result uses.
ReservationAggregates total
The total number of reservation hours that were used.
Copyright © 2023. All rights reserved.