String start
The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example,
if start
is 2017-01-01
, then the cost and usage data is retrieved starting at
2017-01-01
up to the end date.
String end
The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if the
end
is 2017-05-01
, then the cost and usage data is retrieved from the start date but
not including 2017-05-01
.
String key
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.
List<E> values
The metadata values that you can use to filter and group your results. You can use
GetDimensionValues
to find specific values.
List<E> or
Return results that match either Dimension
.
List<E> and
Return results that match both Dimension
objects.
Expression not
Return results that don't match Dimension
.
DimensionValues dimensions
The specific Dimension
to use for Expression
.
TagValues tags
The specific Tag
to use for Expression
.
DateInterval timePeriod
Sets the start and end dates for retrieving AWS 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
.
String granularity
Sets the AWS cost granularity to MONTHLY
or DAILY
.
Expression filter
Filters AWS costs by different dimensions. For example, you can specify Service
and
Linked Account
and get the costs 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 the
Expression
object or More Examples
.
List<E> metrics
Which metrics are returned in the query. For more information about blended and unblended rates, see https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/.
Valid values are BlendedCost
, 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 EC2, the results aren't
meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs.
GB). To get more meaningful UsageQuantity
metrics, filter by UsageType
or
UsageTypeGroups
.
List<E> groupBy
You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.
When you group by tag key, you get all tag values, including empty strings.
Valid values are: AZ
, INSTANCE_TYPE
, LINKED_ACCCOUNT
,
OPERATION
, PURCHASE_TYPE
, SERVICE
, USAGE_TYPE
,
TAGS
, and PLATFORM
.
String nextPageToken
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
String nextPageToken
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
List<E> groupDefinitions
The groups specified by the the Filter
or GroupBy
parameters in the request.
List<E> resultsByTime
The time period covered by the results in the response.
String searchString
The value that you want to search the filter values for.
DateInterval timePeriod
The start and end dates for retrieving the dimension values. 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
.
String dimension
The name of the dimension. Different Dimensions
are available for different Context
s.
For more information, see Context
.
String context
The context for the call to GetDimensionValues
. This can be RESERVED_INSTANCE
or
COST_AND_USAGE
. The default value is COST_AND_USAGE
. If the context is set to
RESERVED_INSTANCE
, the resulting dimension values can be used in the
GetReservationUtilization
action. If the context is set to COST_AND_USAGE
, , the
resulting dimension values can be used in the GetCostAndUsage
operation.
If you set the context to CostAndUsage
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
InstanceType - The type of EC2 instance. An example is m4.xlarge.
LinkedAccount - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account
Operation - The action performed. Examples include RunInstance and CreateBucket.
PurchaseType - The reservation type of the purchase to which this usage is related. Examples include: On Demand Instances and Standard Reserved Instances
Service - The AWS service such as DynamoDB.
UsageType -The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues action includes a unit attribute, examples of which include GB and Hrs.
UsageTypeGroup - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this action includes a unit attribute.
RecordType - The different types of charges such as RI fees, usage costs, tax refunds, and credits
If you set the context to ReservedInstance
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
InstanceType - The type of EC2 instance. An example is m4.xlarge.
LinkedAccount - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account
Platform - The operating system. Examples are Windows or Linux.
Region - The AWS region.
Scope - The scope of a reserved instance (RI). Values are regional or a single availability zone.
Tenancy - The tenancy of a resource. Examples are shared or dedicated.
String nextPageToken
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
List<E> dimensionValues
The filters that you used to filter your request. Some dimensions are available only for a specific context:
If you set the context to CostAndUsage
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
InstanceType - The type of EC2 instance. An example is m4.xlarge.
LinkedAccount - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account
Operation - The action performed. Examples include RunInstance and CreateBucket.
PurchaseType - The reservation type of the purchase to which this usage is related. Examples include: On Demand Instances and Standard Reserved Instances
Service - The AWS service such as DynamoDB.
UsageType -The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues action includes a unit attribute, examples of which include GB and Hrs.
UsageTypeGroup - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this action includes a unit attribute.
RecordType - The different types of charges such as RI fees, usage costs, tax refunds, and credits
If you set the context to ReservedInstance
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a.
InstanceType - The type of EC2 instance. An example is m4.xlarge.
LinkedAccount - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account
Platform - The operating system. Examples are Windows or Linux.
Region - The AWS region.
Scope - The scope of a reserved instance (RI). Values are regional or a single availability zone.
Tenancy - The tenancy of a resource. Examples are shared or dedicated.
Integer returnSize
The number of results that AWS returned at one time.
Integer totalSize
The total number of search results.
String nextPageToken
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
DateInterval timePeriod
Sets the start and end dates for retrieving reserve instance (RI) utilization. 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
.
List<E> groupBy
Groups only by SubscriptionId
. Metadata is included.
String granularity
Sets the AWS cost granularity to MONTHLY
or DAILY
. If both GroupBy
and
granularity
are not set, GetReservationUtilization
defaults to DAILY
. If
GroupBy
is set, Granularity
can't be set, and the response object doesn't include
MONTHLY
or DAILY
granularity.
Expression filter
Filters utilization data by using different dimensions. GetReservationUtilization
uses the same
Expression
object as the other operations, but only AND
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.
String nextPageToken
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
List<E> utilizationsByTime
The amount of time that you utilized your RIs.
ReservationAggregates total
The total amount of time that you utilized your RIs.
String nextPageToken
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
String searchString
The value that you want to search for.
DateInterval timePeriod
The start and end dates for retrieving the dimension values. 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
.
String tagKey
The key of the tag that you want to return values for.
String nextPageToken
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
String nextPageToken
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
List<E> tags
The tags that match your request.
Integer returnSize
The number of query results that AWS returns at a time.
Integer totalSize
The total number of query results.
String utilizationPercentage
The percentage of RI time that you used.
String purchasedHours
How many RI hours you purchased.
String totalActualHours
The total number of RI hours that you used.
String unusedHours
The number of RI hours that you didn't use.
DateInterval timePeriod
The period of time over which this utilization was used.
List<E> groups
The groups that are included in this utilization result.
ReservationAggregates total
The total number of RI hours that were used.
Copyright © 2018. All rights reserved.