String costCategoryArn
The unique identifier for your Cost Category.
String effectiveStart
The Cost Category's effective start date.
String effectiveEnd
The Cost Category's effective end date.
String name
String ruleVersion
List<E> rules
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.
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 associated with a specific Cost Category.
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
, and
LINKED_ACCOUNT_NAME
.
Root level OR
is not supported. We recommend that you create a separate rule instead.
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 AWS Billing and Cost Management User Guide.
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.
String name
String ruleVersion
List<E> rules
The Cost Category rules used to categorize costs. For more information, see CostCategoryRule.
String resourceId
Resource ID of the current instance.
String instanceName
The name you've given an instance. This field will show as blank if you haven't given the instance a name.
List<E> tags
Cost allocation resource tags 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
Number of hours during the lookback period covered by reservations.
String savingsPlansCoveredHoursInLookbackPeriod
Number of hours during the lookback period covered by Savings Plans.
String onDemandHoursInLookbackPeriod
Number of hours during the lookback period billed at On Demand rates.
String totalRunningHoursInLookbackPeriod
The total number of hours the instance ran during the lookback period.
String monthlyCost
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 that you want the usage and costs for. The start date is inclusive. For example,
if start
is 2017-01-01
, AWS retrieves cost and usage data starting at
2017-01-01
up to the end date.
String end
The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if
end
is 2017-05-01
, AWS retrieves cost and usage data from the start date up to, but not
including, 2017-05-01
.
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.
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. The default values for MatchOptions
is EQUALS
and
CASE_SENSITIVE
.
String family
The instance family of the recommended reservation.
String instanceType
The type of instance that AWS recommends.
String region
The AWS 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
Whether the recommended reservation is dedicated or shared.
Boolean currentGeneration
Whether the recommendation is for a current-generation instance.
Boolean sizeFlexEligible
Whether the recommended reservation is size flexible.
String hourlyOnDemandRate
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
Memory capacity of Amazon Web Services instance.
String networkPerformance
Network performance capacity of the Amazon Web Services instance.
String storage
The disk storage of the Amazon Web Services instance (Not EBS storage).
String vcpu
Number of VCPU cores in the Amazon Web Services instance type.
String maxCpuUtilizationPercentage
Maximum observed or expected CPU utilization of the instance.
String maxMemoryUtilizationPercentage
Maximum observed or expected memory utilization of the instance.
String maxStorageUtilizationPercentage
Maximum observed or expected storage utilization of the instance (does not measure EBS storage).
String offeringClass
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 AWS recommends.
String region
The AWS Region of the recommended reservation.
String productDescription
The description of the recommended reservation.
Boolean currentGeneration
Whether the recommendation is for a current generation instance.
Boolean sizeFlexEligible
Whether the recommended reservation is size flexible.
String instanceClass
The class of instance that AWS recommends.
String instanceSize
The size of instance that AWS recommends.
String region
The AWS Region of the recommended reservation.
Boolean currentGeneration
Whether the recommendation is for a current-generation instance.
Boolean sizeFlexEligible
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 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.
DateInterval timePeriod
Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is
exclusive. For example, if start
is 2017-01-01
and end
is
2017-05-01
, then the cost and usage data is retrieved from 2017-01-01
up to and
including 2017-04-30
but not including 2017-05-01
.
String granularity
Sets the AWS cost granularity to MONTHLY
or DAILY
, or HOURLY
. If
Granularity
isn't set, the response object doesn't include the Granularity
, either
MONTHLY
or DAILY
, or HOURLY
.
Expression filter
Filters AWS costs by different dimensions. For example, you can specify SERVICE
and
LINKED_ACCOUNT
and get the costs that are associated with that account's usage of that service. You
can nest Expression
objects to define any combination of dimension filters. For more information,
see Expression.
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 vs. GB). To get more meaningful UsageQuantity
metrics, filter by
UsageType
or UsageTypeGroups
.
Metrics
is required for GetCostAndUsage
requests.
List<E> groupBy
You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.
When you group by tag key, you get all tag values, including empty strings.
Valid values are AZ
, INSTANCE_TYPE
, LEGAL_ENTITY_NAME
,
LINKED_ACCOUNT
, OPERATION
, PLATFORM
, PURCHASE_TYPE
,
SERVICE
, TAGS
, TENANCY
, RECORD_TYPE
, and
USAGE_TYPE
.
String nextPageToken
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
String nextPageToken
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
List<E> groupDefinitions
The groups that are specified by the Filter
or GroupBy
parameters in the request.
List<E> resultsByTime
The time period that is covered by the results in the response.
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 AWS cost granularity to MONTHLY
, DAILY
, or HOURLY
. If
Granularity
isn't set, the response object doesn't include the Granularity
,
MONTHLY
, DAILY
, or HOURLY
.
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
.
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, hours vs. 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: either dimensions, tag keys, or both.
String nextPageToken
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
String nextPageToken
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
List<E> groupDefinitions
The groups that are specified by the Filter
or GroupBy
parameters in the request.
List<E> resultsByTime
The time period that is covered by the results in the response.
DateInterval timePeriod
The period of time that you want the forecast to cover.
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. Cost Explorer API supports all of the Cost Explorer filters.
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 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 dimension
The name of the dimension. Each Dimension
is available for a different Context
. For
more information, see Context
.
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
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge
.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance
and CreateBucket
.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
GetDimensionValues
operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.
If you set the context to RESERVATIONS
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
SingleAZ
and MultiAZ
.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge
.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
If you set the context to SAVINGS_PLANS
, you can use the following dimensions for searching:
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
REGION - The AWS Region.
INSTANCE_TYPE_FAMILY - The family of instances (For example, m5
)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
String nextPageToken
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
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 AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance
and CreateBucket
.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
GetDimensionValues
operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.
If you set the context to RESERVATIONS
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
SingleAZ
and MultiAZ
.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge
.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
If you set the context to SAVINGS_PLANS
, you can use the following dimensions for searching:
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
REGION - The AWS Region.
INSTANCE_TYPE_FAMILY - The family of instances (For example, m5
)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
Integer returnSize
The number of results that AWS returned at one time.
Integer totalSize
The total number of search results.
String nextPageToken
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
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
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TENANCY
String granularity
The granularity of the AWS cost data for the reservation. Valid values are MONTHLY
and
DAILY
.
If GroupBy
is set, Granularity
can't be set. If Granularity
isn't set, the
response object doesn't include Granularity
, either MONTHLY
or DAILY
.
The GetReservationCoverage
operation supports only DAILY
and MONTHLY
granularities.
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. AWS provides the token when the response from a previous call has more results than the maximum page size.
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. AWS provides the token when the response from a previous call has more results than the maximum page size.
String accountId
The account ID that is associated with the recommendation.
String service
The specific service that you want recommendations for.
String accountScope
The account scope that you want your recommendations for. Amazon Web Services calculates recommendations
including the payer account and linked accounts if the value is set to PAYER
. If the value is
LINKED
, recommendations are calculated for individual linked accounts only.
String lookbackPeriodInDays
The number of previous days that you want AWS 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 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.
String nextPageToken
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
List<E> utilizationsByTime
The amount of time that you used your RIs.
ReservationAggregates total
The total amount of time that you used your RIs.
String nextPageToken
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
Expression filter
RightsizingRecommendationConfiguration configuration
Enables you 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 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
Enables you 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 associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.
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
.
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 requested.
String termInYears
The savings plan recommendation term used to generate these recommendations.
String paymentOption
The payment option used to generate these recommendations.
String accountScope
The account scope that you want your recommendations for. Amazon Web Services calculates recommendations
including the payer account and linked accounts if the value is set to PAYER
. If the value is
LINKED
, recommendations are calculated for individual linked 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 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) for which you want to see Savings Plans purchase recommendations.
For GetSavingsPlansPurchaseRecommendation, the Filter
does not 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 for which you want to see Savings Plans Purchase Recommendations. AND
and
OR
operators are not supported.
SavingsPlansPurchaseRecommendationMetadata metadata
Information regarding 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. AWS 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.
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
.
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.
List<E> savingsPlansUtilizationsByTime
The amount of cost/commitment you used your Savings Plans. This allows you 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.
String nextPageToken
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
String nextPageToken
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
List<E> tags
The tags that match your request.
Integer returnSize
The number of query results that AWS 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 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 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. Cost Explorer API supports all of the Cost Explorer filters.
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'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.
EC2InstanceDetails eC2InstanceDetails
The Amazon EC2 instances that AWS recommends that you purchase.
RDSInstanceDetails rDSInstanceDetails
The Amazon RDS instances that AWS recommends that you purchase.
RedshiftInstanceDetails redshiftInstanceDetails
The Amazon Redshift instances that AWS recommends that you purchase.
ElastiCacheInstanceDetails elastiCacheInstanceDetails
The ElastiCache instances that AWS recommends that you purchase.
ESInstanceDetails eSInstanceDetails
The Amazon ES instances that AWS recommends that you purchase.
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 containing 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 family
The instance family of the recommended reservation.
String instanceType
The type of instance that AWS recommends.
String region
The AWS 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
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
Whether the recommendation is for a current-generation instance.
Boolean sizeFlexEligible
Whether the recommended reservation is size flexible.
String family
The instance family of the recommended reservation.
String nodeType
The type of node that AWS recommends.
String region
The AWS Region of the recommended reservation.
Boolean currentGeneration
Whether the recommendation is for a current-generation instance.
Boolean sizeFlexEligible
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, 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
How many Amazon EC2 reservation hours that you purchased, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
String totalActualHours
The total number of reservation hours that you used.
String totalActualUnits
The total number of Amazon EC2 reservation hours that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
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, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
String onDemandCostOfRIHoursUsed
How much your reservation would cost if charged On-Demand rates.
String netRISavings
How much you saved due to purchasing and utilizing reservation. AWS calculates this by subtracting
TotalAmortizedFee
from OnDemandCostOfRIHoursUsed
.
String totalPotentialRISavings
How much you could save if you use your entire reservation.
String amortizedUpfrontFee
The upfront cost of your reservation, amortized over the reservation period.
String amortizedRecurringFee
The monthly cost of your reservation, amortized over the reservation period.
String totalAmortizedFee
The total cost of your reservation, amortized over the reservation period.
String accountScope
The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.
String lookbackPeriodInDays
How many days of previous usage that AWS 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 RI recommendation is for.
InstanceDetails instanceDetails
Details about the instances that AWS recommends that you purchase.
String recommendedNumberOfInstancesToPurchase
The number of instances that AWS recommends that you purchase.
String recommendedNormalizedUnitsToPurchase
The number of normalized units that AWS recommends that you purchase.
String minimumNumberOfInstancesUsedPerHour
The minimum number of instances that you used in an hour during the historical period. AWS 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. AWS 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. AWS 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. AWS 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. AWS 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. AWS uses this to calculate your recommended reservation purchases.
String averageUtilization
The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.
String estimatedBreakEvenInMonths
How long AWS estimates that it takes for this instance to start saving you money, in months.
String currencyCode
The currency code that AWS used to calculate the costs for this instance.
String estimatedMonthlySavingsAmount
How much AWS estimates that this specific recommendation could save you in a month.
String estimatedMonthlySavingsPercentage
How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.
String estimatedMonthlyOnDemandCost
How much AWS estimates that you spend on On-Demand Instances in a month.
String estimatedReservationCostForLookbackPeriod
How much AWS estimates that you would have spent 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 AWS estimates that this recommendation could save you in a month.
String totalEstimatedMonthlySavingsPercentage
The total amount that AWS 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 on the Amazon EC2 resource.
EC2ResourceUtilization eC2ResourceUtilization
Utilization of current Amazon EC2 Instance
String accountId
The account that this recommendation is for.
CurrentInstance currentInstance
Context regarding the current instance.
String rightsizingType
Recommendation to either terminate or modify the resource.
ModifyRecommendationDetail modifyRecommendationDetail
Details for modification recommendations.
TerminateRecommendationDetail terminateRecommendationDetail
Details for termination recommendations.
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
How many days of previous usage that Amazon Web Services considers when making this recommendation.
String totalRecommendationCount
Total number of instance recommendations.
String estimatedTotalMonthlySavingsAmount
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
Savings percentage based on the recommended modifications, relative to the total On-Demand costs associated with these instances.
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 is 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 AWS resources in a geographic area. Each AWS 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 used to distinguish Savings Plans from one another.
String accountScope
The account scope that you want your recommendations for. Amazon Web Services calculates recommendations
including the payer account and linked accounts if the value is set to PAYER
. If the value is
LINKED
, recommendations are calculated for individual linked accounts only.
String savingsPlansType
The requested Savings Plans recommendation type.
String termInYears
The Savings Plans recommendation term in years, used to generate the recommendation.
String paymentOption
The payment option used to generate the recommendation.
String lookbackPeriodInDays
The lookback period in days, used to generate the recommendation.
List<E> savingsPlansPurchaseRecommendationDetails
Details for the Savings Plans 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 based on the recommended Savings Plans purchased. This is calculated as
estimatedSavingsAmount
/ estimatedSPCost
*100.
String currencyCode
The currency code 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 would 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 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 configuration 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 estimatedROI
The estimated return on investment based on the recommended Savings Plans and estimated savings.
String currencyCode
The currency code 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 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, based on the recommended Savings Plans purchase.
String estimatedOnDemandCostWithCurrentCommitment
The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own.
String netSavings
The savings amount that you are accumulating for the usage that is covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.
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 was not 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 saved by using existing Savings Plans. Savings returns both net savings from Savings Plans, as well as
the onDemandCostEquivalent
of the Savings Plans when considering the utilization rate.
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 saved by using existing Savings Plans. Savings returns both net savings from Savings Plans as well as
the onDemandCostEquivalent
of the Savings Plans when considering the utilization rate.
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 as well as
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 AWS to provide recommendations for.
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 only
applicable for actions related to Cost Category. The default values for MatchOptions
is
EQUALS
and CASE_SENSITIVE
.
String estimatedMonthlyCost
Expected cost to operate this instance type on a monthly basis.
String estimatedMonthlySavings
Estimated savings resulting 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
Indicates whether or not this recommendation is the defaulted Amazon Web Services recommendation.
ResourceDetails resourceDetails
Details on the target instance type.
ResourceUtilization expectedResourceUtilization
Expected utilization metrics for target instance type.
String costCategoryArn
The unique identifier for your Cost Category.
String ruleVersion
List<E> rules
The Expression
object used to categorize costs. For more information, see CostCategoryRule .
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 © 2020. All rights reserved.