GetDimensionValuesRequest
import type { GetDimensionValuesRequest } from "https://aws-api.deno.dev/v0.3/services/costexplorer.ts?docs=full";
§Properties
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 Amazon EC2 instance.
An example is
m4.xlarge
. - LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services 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 Amazon Web Services ID of the member account.
- OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
- OPERATION - The action performed.
Examples include
RunInstance
andCreateBucket
. - PLATFORM - The Amazon 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 Amazon Web Services 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 Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
- REGION - The Amazon Web Services Region.
- RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
- RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.
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
andMultiAZ
. - INSTANCE_TYPE - The type of Amazon 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 Amazon Web Services ID of the member account.
- PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
- REGION - The Amazon Web Services 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.
If you set the context to SAVINGS_PLANS
, you can use the following dimensions for searching:
- SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
- PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
- REGION - The Amazon Web Services Region.
- INSTANCE_TYPE_FAMILY - The family of instances (For example,
m5
) - LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
- SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
For GetDimensionValues
, MaxResults has an upper limit of 1000.
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.
The value by which you want to sort the data.
The key represents cost and usage metrics. The following values are supported:
-
BlendedCost
-
UnblendedCost
-
AmortizedCost
-
NetAmortizedCost
-
NetUnblendedCost
-
UsageQuantity
-
NormalizedUsageAmount
Supported values for SortOrder
are ASCENDING
or DESCENDING
.
When you specify a SortBy
paramater, the context must be COST_AND_USAGE
.
Further, when using SortBy
, NextPageToken
and SearchString
are not supported.
The start date and end date 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
.