AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues
in SAVINGS_PLANS
to determine the possible dimension values.
GetSavingsPlansUtilization
.See also: AWS API Documentation
get-savings-plans-utilization
--time-period <value>
[--granularity <value>]
[--filter <value>]
[--sort-by <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--time-period
(structure)
The time period that you want the usage and costs for. The
Start
date must be within 13 months. TheEnd
date must be after theStart
date, and before the current date. Future dates can't be used as anEnd
date.Start -> (string)
The beginning of the time period. The start date is inclusive. For example, ifstart
is2017-01-01
, Amazon Web Services retrieves cost and usage data starting at2017-01-01
up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.End -> (string)
The end of the time period. The end date is exclusive. For example, ifend
is2017-05-01
, Amazon Web Services retrieves cost and usage data from the start date up to, but not including,2017-05-01
.
Shorthand Syntax:
Start=string,End=string
JSON Syntax:
{
"Start": "string",
"End": "string"
}
--granularity
(string)
The granularity of the Amazon Web Services utillization data for your Savings Plans.
The
GetSavingsPlansUtilization
operation supports onlyDAILY
andMONTHLY
granularities.Possible values:
DAILY
MONTHLY
HOURLY
--filter
(structure)
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 onlyAND
is supported among each dimension.Or -> (list)
Return results that match either
Dimension
object.(structure)
Use
Expression
to filter in various Cost Explorer APIs.Not all
Expression
types are supported in each API. Refer to the documentation for each specific API to see what is supported.There are two patterns:
- Simple dimension values.
- There are three types of simple dimension values:
CostCategories
,Tags
, andDimensions
.
- Specify the
CostCategories
field to define a filter that acts on Cost Categories.- Specify the
Tags
field to define a filter that acts on Cost Allocation Tags.- Specify the
Dimensions
field to define a filter that acts on the `DimensionValues
https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html`__ .- For each filter type, you can set the dimension name and values for the filters that you plan to use.
- For example, you can filter for
REGION==us-east-1 OR REGION==us-west-1
. ForGetRightsizingRecommendation
, the Region is a full name (for example,REGION==US East (N. Virginia)
.- The corresponding
Expression
for this example is as follows:{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }
- As shown in the previous example, lists of dimension values are combined with
OR
when applying the filter.- You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.
- For example, you can filter for linked account names that start with "a".
- The corresponding
Expression
for this example is as follows:{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }
- Compound
Expression
types with logical operations.
- You can use multiple
Expression
types and the logical operatorsAND/OR/NOT
to create a list of one or moreExpression
objects. By doing this, you can filter by more advanced options.- For example, you can filter by
((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)
.- The corresponding
Expression
for this example is as follows:{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
Note
Because each
Expression
can have only one operator, the service returns an error if more than one is specified. The following example shows anExpression
object that creates an error:{ "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
The following is an example of the corresponding error message:
"Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
Note
For the
GetRightsizingRecommendation
action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited toLINKED_ACCOUNT
,REGION
, orRIGHTSIZING_TYPE
.For the
GetReservationPurchaseRecommendation
action, only NOT is supported. AND and OR aren't supported. Dimensions are limited toLINKED_ACCOUNT
.Or -> (list)
Return results that match either
Dimension
object.( ... recursive ... )
And -> (list)
Return results that match both
Dimension
objects.( ... recursive ... )
( ... recursive ... )Dimensions -> (structure)
The specific
Dimension
to use forExpression
.Key -> (string)
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
andSERVICE_CODE
can only be used in CostCategoryRule .
ANOMALY_TOTAL_IMPACT_ABSOLUTE
andANOMALY_TOTAL_IMPACT_PERCENTAGE
can only be used in AnomalySubscriptions .Values -> (list)
The metadata values that you can use to filter and group your results. You can use
GetDimensionValues
to find specific values.(string)
MatchOptions -> (list)
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
areEQUALS
andCASE_SENSITIVE
.(string)
Tags -> (structure)
The specific
Tag
to use forExpression
.Key -> (string)
The key for the tag.Values -> (list)
The specific value of the tag.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
CostCategories -> (structure)
The filter that's based on
CostCategory
values.Key -> (string)
The unique name of the Cost Category.Values -> (list)
The specific value of the Cost Category.
(string)
MatchOptions -> (list)
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
isEQUALS
andCASE_SENSITIVE
.(string)
And -> (list)
Return results that match both
Dimension
objects.(structure)
Use
Expression
to filter in various Cost Explorer APIs.Not all
Expression
types are supported in each API. Refer to the documentation for each specific API to see what is supported.There are two patterns:
- Simple dimension values.
- There are three types of simple dimension values:
CostCategories
,Tags
, andDimensions
.
- Specify the
CostCategories
field to define a filter that acts on Cost Categories.- Specify the
Tags
field to define a filter that acts on Cost Allocation Tags.- Specify the
Dimensions
field to define a filter that acts on the `DimensionValues
https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html`__ .- For each filter type, you can set the dimension name and values for the filters that you plan to use.
- For example, you can filter for
REGION==us-east-1 OR REGION==us-west-1
. ForGetRightsizingRecommendation
, the Region is a full name (for example,REGION==US East (N. Virginia)
.- The corresponding
Expression
for this example is as follows:{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }
- As shown in the previous example, lists of dimension values are combined with
OR
when applying the filter.- You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.
- For example, you can filter for linked account names that start with "a".
- The corresponding
Expression
for this example is as follows:{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }
- Compound
Expression
types with logical operations.
- You can use multiple
Expression
types and the logical operatorsAND/OR/NOT
to create a list of one or moreExpression
objects. By doing this, you can filter by more advanced options.- For example, you can filter by
((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)
.- The corresponding
Expression
for this example is as follows:{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
Note
Because each
Expression
can have only one operator, the service returns an error if more than one is specified. The following example shows anExpression
object that creates an error:{ "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
The following is an example of the corresponding error message:
"Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
Note
For the
GetRightsizingRecommendation
action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited toLINKED_ACCOUNT
,REGION
, orRIGHTSIZING_TYPE
.For the
GetReservationPurchaseRecommendation
action, only NOT is supported. AND and OR aren't supported. Dimensions are limited toLINKED_ACCOUNT
.Or -> (list)
Return results that match either
Dimension
object.( ... recursive ... )
And -> (list)
Return results that match both
Dimension
objects.( ... recursive ... )
( ... recursive ... )Dimensions -> (structure)
The specific
Dimension
to use forExpression
.Key -> (string)
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
andSERVICE_CODE
can only be used in CostCategoryRule .
ANOMALY_TOTAL_IMPACT_ABSOLUTE
andANOMALY_TOTAL_IMPACT_PERCENTAGE
can only be used in AnomalySubscriptions .Values -> (list)
The metadata values that you can use to filter and group your results. You can use
GetDimensionValues
to find specific values.(string)
MatchOptions -> (list)
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
areEQUALS
andCASE_SENSITIVE
.(string)
Tags -> (structure)
The specific
Tag
to use forExpression
.Key -> (string)
The key for the tag.Values -> (list)
The specific value of the tag.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
CostCategories -> (structure)
The filter that's based on
CostCategory
values.Key -> (string)
The unique name of the Cost Category.Values -> (list)
The specific value of the Cost Category.
(string)
MatchOptions -> (list)
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
isEQUALS
andCASE_SENSITIVE
.(string)
Not -> (structure)
Return results that don't match a
Dimension
object.Or -> (list)
Return results that match either
Dimension
object.( ... recursive ... )
And -> (list)
Return results that match both
Dimension
objects.( ... recursive ... )
( ... recursive ... )Dimensions -> (structure)
The specific
Dimension
to use forExpression
.Key -> (string)
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
andSERVICE_CODE
can only be used in CostCategoryRule .
ANOMALY_TOTAL_IMPACT_ABSOLUTE
andANOMALY_TOTAL_IMPACT_PERCENTAGE
can only be used in AnomalySubscriptions .Values -> (list)
The metadata values that you can use to filter and group your results. You can use
GetDimensionValues
to find specific values.(string)
MatchOptions -> (list)
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
areEQUALS
andCASE_SENSITIVE
.(string)
Tags -> (structure)
The specific
Tag
to use forExpression
.Key -> (string)
The key for the tag.Values -> (list)
The specific value of the tag.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
CostCategories -> (structure)
The filter that's based on
CostCategory
values.Key -> (string)
The unique name of the Cost Category.Values -> (list)
The specific value of the Cost Category.
(string)
MatchOptions -> (list)
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
isEQUALS
andCASE_SENSITIVE
.(string)
Dimensions -> (structure)
The specific
Dimension
to use forExpression
.Key -> (string)
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
andSERVICE_CODE
can only be used in CostCategoryRule .
ANOMALY_TOTAL_IMPACT_ABSOLUTE
andANOMALY_TOTAL_IMPACT_PERCENTAGE
can only be used in AnomalySubscriptions .Values -> (list)
The metadata values that you can use to filter and group your results. You can use
GetDimensionValues
to find specific values.(string)
MatchOptions -> (list)
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
areEQUALS
andCASE_SENSITIVE
.(string)
Tags -> (structure)
The specific
Tag
to use forExpression
.Key -> (string)
The key for the tag.Values -> (list)
The specific value of the tag.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
CostCategories -> (structure)
The filter that's based on
CostCategory
values.Key -> (string)
The unique name of the Cost Category.Values -> (list)
The specific value of the Cost Category.
(string)
MatchOptions -> (list)
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
isEQUALS
andCASE_SENSITIVE
.(string)
JSON Syntax:
{
"Or": [
{
"Or": [
{ ... recursive ... }
...
],
"And": [
{ ... recursive ... }
...
],
"Not": { ... recursive ... },
"Dimensions": {
"Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
},
"Tags": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
},
"CostCategories": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
}
}
...
],
"And": [
{
"Or": [
{ ... recursive ... }
...
],
"And": [
{ ... recursive ... }
...
],
"Not": { ... recursive ... },
"Dimensions": {
"Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
},
"Tags": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
},
"CostCategories": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
}
}
...
],
"Not": {
"Or": [
{ ... recursive ... }
...
],
"And": [
{ ... recursive ... }
...
],
"Not": { ... recursive ... },
"Dimensions": {
"Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
},
"Tags": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
},
"CostCategories": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
}
},
"Dimensions": {
"Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
},
"Tags": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
},
"CostCategories": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
}
}
--sort-by
(structure)
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
areASCENDING
andDESCENDING
.Key -> (string)
The key that's used to sort the data.SortOrder -> (string)
The order that's used to sort the data.
Shorthand Syntax:
Key=string,SortOrder=string
JSON Syntax:
{
"Key": "string",
"SortOrder": "ASCENDING"|"DESCENDING"
}
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
SavingsPlansUtilizationsByTime -> (list)
The amount of cost/commitment that you used your Savings Plans. You can use it to specify date ranges.
(structure)
The amount of Savings Plans utilization (in hours).
TimePeriod -> (structure)
The time period of the request.
Start -> (string)
The beginning of the time period. The start date is inclusive. For example, ifstart
is2017-01-01
, Amazon Web Services retrieves cost and usage data starting at2017-01-01
up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.End -> (string)
The end of the time period. The end date is exclusive. For example, ifend
is2017-05-01
, Amazon Web Services retrieves cost and usage data from the start date up to, but not including,2017-05-01
.Utilization -> (structure)
A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.
TotalCommitment -> (string)
The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).UsedCommitment -> (string)
The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.UnusedCommitment -> (string)
The amount of your Savings Plans commitment that wasn't consumed from Savings Plans eligible usage in a specific period.UtilizationPercentage -> (string)
The amount ofUsedCommitment
divided by theTotalCommitment
for your Savings Plans.Savings -> (structure)
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.NetSavings -> (string)
The savings amount that you're accumulating for the usage that's covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.OnDemandCostEquivalent -> (string)
How much the amount that the usage would have cost if it was accrued at the On-Demand rate.AmortizedCommitment -> (structure)
The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.
AmortizedRecurringCommitment -> (string)
The amortized amount of your Savings Plans commitment that was purchased with either aPartial
or aNoUpfront
.AmortizedUpfrontCommitment -> (string)
The amortized amount of your Savings Plans commitment that was purchased with anUpfront
orPartialUpfront
Savings Plans.TotalAmortizedCommitment -> (string)
The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.
Total -> (structure)
The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.
Utilization -> (structure)
A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.
TotalCommitment -> (string)
The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).UsedCommitment -> (string)
The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.UnusedCommitment -> (string)
The amount of your Savings Plans commitment that wasn't consumed from Savings Plans eligible usage in a specific period.UtilizationPercentage -> (string)
The amount ofUsedCommitment
divided by theTotalCommitment
for your Savings Plans.Savings -> (structure)
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.NetSavings -> (string)
The savings amount that you're accumulating for the usage that's covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.OnDemandCostEquivalent -> (string)
How much the amount that the usage would have cost if it was accrued at the On-Demand rate.AmortizedCommitment -> (structure)
The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.
AmortizedRecurringCommitment -> (string)
The amortized amount of your Savings Plans commitment that was purchased with either aPartial
or aNoUpfront
.AmortizedUpfrontCommitment -> (string)
The amortized amount of your Savings Plans commitment that was purchased with anUpfront
orPartialUpfront
Savings Plans.TotalAmortizedCommitment -> (string)
The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.