Get Reservation Utilization
costexplorer_get_reservation_utilization | R Documentation |
Retrieves the reservation utilization for your account¶
Description¶
Retrieves the reservation utilization for your account. Management
account in an organization have access to member accounts. You can
filter data by dimensions in a time period. You can use
get_dimension_values
to determine the possible dimension values.
Currently, you can group only by SUBSCRIPTION_ID
.
Usage¶
costexplorer_get_reservation_utilization(TimePeriod, GroupBy,
Granularity, Filter, SortBy, NextPageToken, MaxResults)
Arguments¶
TimePeriod
[required] 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
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.GroupBy
Groups only by
SUBSCRIPTION_ID
. Metadata is included.Granularity
If
GroupBy
is set,Granularity
can't be set. IfGranularity
isn't set, the response object doesn't includeGranularity
, eitherMONTHLY
orDAILY
. If bothGroupBy
andGranularity
aren't set,get_reservation_utilization
defaults toDAILY
.The
get_reservation_utilization
operation supports onlyDAILY
andMONTHLY
granularities.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
get_reservation_utilization
uses the same Expression object as the other operations, but onlyAND
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.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
areASCENDING
andDESCENDING
.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.
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.
Value¶
A list with the following syntax:
list(
UtilizationsByTime = list(
list(
TimePeriod = list(
Start = "string",
End = "string"
),
Groups = list(
list(
Key = "string",
Value = "string",
Attributes = list(
"string"
),
Utilization = list(
UtilizationPercentage = "string",
UtilizationPercentageInUnits = "string",
PurchasedHours = "string",
PurchasedUnits = "string",
TotalActualHours = "string",
TotalActualUnits = "string",
UnusedHours = "string",
UnusedUnits = "string",
OnDemandCostOfRIHoursUsed = "string",
NetRISavings = "string",
TotalPotentialRISavings = "string",
AmortizedUpfrontFee = "string",
AmortizedRecurringFee = "string",
TotalAmortizedFee = "string",
RICostForUnusedHours = "string",
RealizedSavings = "string",
UnrealizedSavings = "string"
)
)
),
Total = list(
UtilizationPercentage = "string",
UtilizationPercentageInUnits = "string",
PurchasedHours = "string",
PurchasedUnits = "string",
TotalActualHours = "string",
TotalActualUnits = "string",
UnusedHours = "string",
UnusedUnits = "string",
OnDemandCostOfRIHoursUsed = "string",
NetRISavings = "string",
TotalPotentialRISavings = "string",
AmortizedUpfrontFee = "string",
AmortizedRecurringFee = "string",
TotalAmortizedFee = "string",
RICostForUnusedHours = "string",
RealizedSavings = "string",
UnrealizedSavings = "string"
)
)
),
Total = list(
UtilizationPercentage = "string",
UtilizationPercentageInUnits = "string",
PurchasedHours = "string",
PurchasedUnits = "string",
TotalActualHours = "string",
TotalActualUnits = "string",
UnusedHours = "string",
UnusedUnits = "string",
OnDemandCostOfRIHoursUsed = "string",
NetRISavings = "string",
TotalPotentialRISavings = "string",
AmortizedUpfrontFee = "string",
AmortizedRecurringFee = "string",
TotalAmortizedFee = "string",
RICostForUnusedHours = "string",
RealizedSavings = "string",
UnrealizedSavings = "string"
),
NextPageToken = "string"
)
Request syntax¶
svc$get_reservation_utilization(
TimePeriod = list(
Start = "string",
End = "string"
),
GroupBy = list(
list(
Type = "DIMENSION"|"TAG"|"COST_CATEGORY",
Key = "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"
),
NextPageToken = "string",
MaxResults = 123
)