Get Cost And Usage With Resources
costexplorer_get_cost_and_usage_with_resources | R Documentation |
Retrieves cost and usage metrics with resources for your account¶
Description¶
Retrieves cost and usage metrics with resources for your account. You
can specify which cost and usage-related metric, such as BlendedCosts
or UsageQuantity
, that you want the request to return. You can also
filter and group your data by various dimensions, such as SERVICE
or
AZ
, in a specific time range. For a complete list of valid dimensions,
see the get_dimension_values
operation. Management account in an
organization in Organizations have access to all member accounts.
Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud) resource-level data. All other resource-level data is available at daily granularity.
This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information about how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.
Usage¶
costexplorer_get_cost_and_usage_with_resources(TimePeriod, Granularity,
Filter, Metrics, GroupBy, NextPageToken)
Arguments¶
TimePeriod
[required] 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
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
.Granularity
[required] Sets the Amazon Web Services cost granularity to
MONTHLY
,DAILY
, orHOURLY
. IfGranularity
isn't set, the response object doesn't include theGranularity
,MONTHLY
,DAILY
, orHOURLY
.Filter
[required] Filters Amazon Web Services costs by different dimensions. For example, you can specify
SERVICE
andLINKED_ACCOUNT
and get the costs that are associated with that account's usage of that service. You can nestExpression
objects to define any combination of dimension filters. For more information, see Expression.The
get_cost_and_usage_with_resources
operation requires that you either group by or filter by aResourceId
. It requires the Expression"SERVICE = Amazon Elastic Compute Cloud - Compute"
in the filter.Valid values for
MatchOptions
forDimensions
areEQUALS
andCASE_SENSITIVE
.Valid values for
MatchOptions
forCostCategories
andTags
areEQUALS
,ABSENT
, andCASE_SENSITIVE
. Default values areEQUALS
andCASE_SENSITIVE
.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
, andUsageQuantity
.If you return the
UsageQuantity
metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregateusageQuantity
across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hour or GB). To get more meaningfulUsageQuantity
metrics, filter byUsageType
orUsageTypeGroups
.Metrics
is required forget_cost_and_usage_with_resources
requests.GroupBy
You can group Amazon Web Services costs using up to two different groups:
DIMENSION
,TAG
,COST_CATEGORY
.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.
Value¶
A list with the following syntax:
list(
NextPageToken = "string",
GroupDefinitions = list(
list(
Type = "DIMENSION"|"TAG"|"COST_CATEGORY",
Key = "string"
)
),
ResultsByTime = list(
list(
TimePeriod = list(
Start = "string",
End = "string"
),
Total = list(
list(
Amount = "string",
Unit = "string"
)
),
Groups = list(
list(
Keys = list(
"string"
),
Metrics = list(
list(
Amount = "string",
Unit = "string"
)
)
)
),
Estimated = TRUE|FALSE
)
),
DimensionValueAttributes = list(
list(
Value = "string",
Attributes = list(
"string"
)
)
)
)
Request syntax¶
svc$get_cost_and_usage_with_resources(
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"
)
)
),
Metrics = list(
"string"
),
GroupBy = list(
list(
Type = "DIMENSION"|"TAG"|"COST_CATEGORY",
Key = "string"
)
),
NextPageToken = "string"
)