CoverageHours coverageHours
The amount of instance usage that a reservation covered, in hours.
DateInterval timePeriod
The period over which this coverage was used.
List<E> groups
The groups of instances that are covered by a reservation.
Coverage total
The total reservation coverage, in hours.
String onDemandHours
The number of instance running hours that are covered by On-Demand Instances.
String reservedHours
The number of instance running hours that are covered by reservations.
String totalRunningHours
The total instance usage, in hours.
String coverageHoursPercentage
The percentage of instance hours that are covered by a reservation.
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
, AWS retrieves cost and usage data 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
end
is 2017-05-01
, AWS retrieves cost and usage data from the start date up to, 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.
String family
The instance family of the recommended reservation.
String instanceType
The type of instance that AWS recommends.
String region
The AWS Region of the recommended reservation.
String availabilityZone
The Availability Zone of the recommended reservation.
String platform
The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.
String tenancy
Whether the recommended reservation is dedicated or shared.
Boolean currentGeneration
Whether the recommendation is for a current generation instance.
Boolean sizeFlexEligible
Whether the recommended reservation is size flexible.
String offeringClass
Whether you want a recommendation for standard or convertible reservations.
List<E> or
Return results that match either Dimension
object.
List<E> and
Return results that match both Dimension
objects.
Expression not
Return results that don't match a Dimension
object.
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
. If Granularity
isn't
set, the response object doesn't include the Granularity
, either MONTHLY
or
DAILY
.
Expression filter
Filters AWS 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.
List<E> 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 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
.
Metrics
is required for GetCostAndUsage
requests.
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
, LEGAL_ENTITY_NAME
,
LINKED_ACCOUNT
, OPERATION
, PLATFORM
, PURCHASE_TYPE
,
SERVICE
, TAGS
, TENANCY
, and USAGE_TYPE
.
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 that are specified by the Filter
or GroupBy
parameters in the request.
List<E> resultsByTime
The time period that is 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. Each Dimension
is available for different a Context
. For
more information, see Context
.
String context
The context for the call to GetDimensionValues
. This can be RESERVATIONS
or
COST_AND_USAGE
. The default value is COST_AND_USAGE
. If the context is set to
RESERVATIONS
, the resulting dimension values can be used in the
GetReservationUtilization
operation. 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 COST_AND_USAGE
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge
.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - 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.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance
and CreateBucket
.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - 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 Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
GetDimensionValues
operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
If you set the context to RESERVATIONS
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
SingleAZ
and MultiAZ
.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge
.
LINKED_ACCOUNT - 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 EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
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 COST_AND_USAGE
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge
.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - 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.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance
and CreateBucket
.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - 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 Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
GetDimensionValues
operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
If you set the context to RESERVATIONS
, you can use the following dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
SingleAZ
and MultiAZ
.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge
.
LINKED_ACCOUNT - 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 EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
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
The start and end dates of the period for which you want to retrieve data about reservation coverage. You can
retrieve data for a maximum of 13 months: the last 12 months and the current month. 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
You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TAG
TENANCY
String granularity
The granularity of the AWS cost data for the reservation. Valid values are MONTHLY
and
DAILY
.
If GroupBy
is set, Granularity
can't be set. If Granularity
isn't set, the
response object doesn't include Granularity
, either MONTHLY
or DAILY
.
Expression filter
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
GetReservationCoverage
uses the same
Expression
object as the other operations, but only AND
is supported among each dimension. You can nest 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> coveragesByTime
The amount of time that your reservations covered.
Coverage total
The total amount of instance usage that is covered by a reservation.
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 accountId
The account ID that is associated with the recommendation.
String service
The specific service that you want recommendations for.
String accountScope
The account scope that you want recommendations for. The only valid value is Payer
. This means that
AWS includes the master account and any member accounts when it calculates its recommendations.
String lookbackPeriodInDays
The number of previous days that you want AWS to consider when it calculates your recommendations.
String termInYears
The reservation term that you want recommendations for.
String paymentOption
The reservation purchase option that you want recommendations for.
ServiceSpecification serviceSpecification
The hardware specifications for the service instances that you want recommendations for, such as standard or convertible EC2 instances.
Integer pageSize
The number of recommendations that you want returned in a single response object.
String nextPageToken
The pagination token that indicates the next set of results that you want to retrieve.
ReservationPurchaseRecommendationMetadata metadata
Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.
List<E> recommendations
Recommendations for reservations to purchase.
String nextPageToken
The pagination token for the next set of retrievable results.
DateInterval timePeriod
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
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 SUBSCRIPTION_ID
. Metadata is included.
String granularity
If GroupBy
is set, Granularity
can't be set. If Granularity
isn't set, the
response object doesn't include Granularity
, either MONTHLY
or DAILY
. If
both GroupBy
and Granularity
aren't set, GetReservationUtilization
defaults to DAILY
.
Expression filter
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
SCOPE
TENANCY
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.
EC2InstanceDetails eC2InstanceDetails
The EC2 instances that AWS recommends that you purchase.
RDSInstanceDetails rDSInstanceDetails
The RDS instances that AWS recommends that you purchase.
String family
The instance family of the recommended reservation.
String instanceType
The type of instance that AWS recommends.
String region
The AWS Region of the recommended reservation.
String databaseEngine
The database engine that the recommended reservation supports.
String deploymentOption
Whether the recommendation is for a reservation in a single availability zone or a reservation with a backup in a second availability zone.
String licenseModel
The license model that the recommended reservation supports.
Boolean currentGeneration
Whether the recommendation is for a current generation instance.
Boolean sizeFlexEligible
Whether the recommended reservation is size flexible.
String utilizationPercentage
The percentage of RI time that you used.
String purchasedHours
How many RI hours that 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.
String accountScope
The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.
String lookbackPeriodInDays
How many days of previous usage that AWS takes into consideration when making this recommendation.
String termInYears
The term of the reservation that you want recommendations for, in years.
String paymentOption
The payment option for the reservation. For example, AllUpfront
or NoUpfront
.
ServiceSpecification serviceSpecification
Hardware specifications for the service that you want recommendations for.
List<E> recommendationDetails
Details about the recommended purchases.
ReservationPurchaseRecommendationSummary recommendationSummary
A summary about the recommended purchase.
InstanceDetails instanceDetails
Details about the instances that AWS recommends that you purchase.
String recommendedNumberOfInstancesToPurchase
The number of instances that AWS recommends that you purchase.
String recommendedNormalizedUnitsToPurchase
The number of normalized units that AWS recommends that you purchase.
String minimumNumberOfInstancesUsedPerHour
The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
String minimumNormalizedUnitsUsedPerHour
The minimum number of hours that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
String maximumNumberOfInstancesUsedPerHour
The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
String maximumNormalizedUnitsUsedPerHour
The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
String averageNumberOfInstancesUsedPerHour
The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
String averageNormalizedUnitsUsedPerHour
The average number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
String averageUtilization
The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.
String estimatedBreakEvenInMonths
How long AWS estimates that it takes for this instance to start saving you money, in months.
String currencyCode
The currency code that AWS used to calculate the costs for this instance.
String estimatedMonthlySavingsAmount
How much AWS estimates that this specific recommendation could save you in a month.
String estimatedMonthlySavingsPercentage
How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.
String estimatedMonthlyOnDemandCost
How much AWS estimates that you spend on On-Demand Instances in a month.
String estimatedReservationCostForLookbackPeriod
How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation.
String upfrontCost
How much purchasing this instance costs you upfront.
String recurringStandardMonthlyCost
How much purchasing this instance costs you on a monthly basis.
String totalEstimatedMonthlySavingsAmount
The total amount that AWS estimates that this recommendation could save you in a month.
String totalEstimatedMonthlySavingsPercentage
The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs.
String currencyCode
The currency code used for this recommendation.
EC2Specification eC2Specification
The EC2 hardware specifications that you want AWS to provide recommendations for.
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.