Get Savings Plans Utilization
costexplorer_get_savings_plans_utilization | R Documentation |
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity¶
Description¶
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
get_dimension_values
in SAVINGS_PLANS
to determine the possible
dimension values.
You can't group by any dimension values for
get_savings_plans_utilization
.
Usage¶
costexplorer_get_savings_plans_utilization(TimePeriod, Granularity,
Filter, SortBy)
Arguments¶
TimePeriod |
[required] The time period that you want the usage and costs for.
The |
Granularity |
The granularity of the Amazon Web Services utillization data for your Savings Plans. The |
Filter |
Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
|
SortBy |
The value that you want to sort the data by. The following values are supported for
The supported values for |
Value¶
A list with the following syntax:
list(
SavingsPlansUtilizationsByTime = list(
list(
TimePeriod = list(
Start = "string",
End = "string"
),
Utilization = list(
TotalCommitment = "string",
UsedCommitment = "string",
UnusedCommitment = "string",
UtilizationPercentage = "string"
),
Savings = list(
NetSavings = "string",
OnDemandCostEquivalent = "string"
),
AmortizedCommitment = list(
AmortizedRecurringCommitment = "string",
AmortizedUpfrontCommitment = "string",
TotalAmortizedCommitment = "string"
)
)
),
Total = list(
Utilization = list(
TotalCommitment = "string",
UsedCommitment = "string",
UnusedCommitment = "string",
UtilizationPercentage = "string"
),
Savings = list(
NetSavings = "string",
OnDemandCostEquivalent = "string"
),
AmortizedCommitment = list(
AmortizedRecurringCommitment = "string",
AmortizedUpfrontCommitment = "string",
TotalAmortizedCommitment = "string"
)
)
)
Request syntax¶
svc$get_savings_plans_utilization(
TimePeriod = list(
Start = "string",
End = "string"
),
Granularity = "DAILY"|"MONTHLY"|"HOURLY",
Filter = list(
Or = list(
list()
),
And = list(
list()
),
Not = list(),
Dimensions = list(
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 = list(
"string"
),
MatchOptions = list(
"EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
)
),
Tags = list(
Key = "string",
Values = list(
"string"
),
MatchOptions = list(
"EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
)
),
CostCategories = list(
Key = "string",
Values = list(
"string"
),
MatchOptions = list(
"EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
)
)
),
SortBy = list(
Key = "string",
SortOrder = "ASCENDING"|"DESCENDING"
)
)