Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you want the request to return. For example, you can specify BlendedCosts
or UsageQuantity
. 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.
See https://www.paws-r-sdk.com/docs/costexplorer_get_cost_and_usage/ for full documentation.
costexplorer_get_cost_and_usage(
TimePeriod,
Granularity,
Filter = NULL,
Metrics,
GroupBy = NULL,
BillingViewArn = NULL,
NextPageToken = NULL
)
[required] Sets the start date and end date for retrieving Amazon Web Services
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
.
[required] Sets the Amazon Web Services 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
.
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.
Valid values for MatchOptions
for Dimensions
are EQUALS
and
CASE_SENSITIVE
.
Valid values for MatchOptions
for CostCategories
and Tags
are
EQUALS
, ABSENT
, and CASE_SENSITIVE
. Default values are EQUALS
and CASE_SENSITIVE
.
[required] 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 and GB). To get more
meaningful UsageQuantity
metrics, filter by UsageType
or
UsageTypeGroups
.
Metrics
is required for
get_cost_and_usage
requests.
You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.
Valid values for the DIMENSION
type are AZ
, INSTANCE_TYPE
,
LEGAL_ENTITY_NAME
, INVOICING_ENTITY
, LINKED_ACCOUNT
, OPERATION
,
PLATFORM
, PURCHASE_TYPE
, SERVICE
, TENANCY
, RECORD_TYPE
, and
USAGE_TYPE
.
When you group by the TAG
type and include a valid tag key, you get
all tag values, including empty strings.
The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.
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.