GetDimensionValues
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
Request Syntax
{
"Context": "string
",
"Dimension": "string
",
"Filter": {
"And": [
"Expression"
],
"CostCategories": {
"Key": "string
",
"MatchOptions": [ "string
" ],
"Values": [ "string
" ]
},
"Dimensions": {
"Key": "string
",
"MatchOptions": [ "string
" ],
"Values": [ "string
" ]
},
"Not": "Expression",
"Or": [
"Expression"
],
"Tags": {
"Key": "string
",
"MatchOptions": [ "string
" ],
"Values": [ "string
" ]
}
},
"MaxResults": number
,
"NextPageToken": "string
",
"SearchString": "string
",
"SortBy": [
{
"Key": "string
",
"SortOrder": "string
"
}
],
"TimePeriod": {
"End": "string
",
"Start": "string
"
}
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Context
-
The context for the call to
GetDimensionValues
. This can beRESERVATIONS
orCOST_AND_USAGE
. The default value isCOST_AND_USAGE
. If the context is set toRESERVATIONS
, the resulting dimension values can be used in theGetReservationUtilization
operation. If the context is set toCOST_AND_USAGE
, the resulting dimension values can be used in theGetCostAndUsage
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
. -
BILLING_ENTITY - The AWS seller that your account is with. Possible values are the following:
- AWS(Amazon Web Services): The entity that sells AWS services.
- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for AWS services in India.
- AWS Marketplace: The entity that supports the sale of solutions that are built on AWS by third-party software providers.
-
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
. -
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
. -
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are
Compute Optimized
(for example,C4
,C5
,C6g
, andC7g
),Memory Optimization
(for example,R4
,R5n
,R5b
, andR6g
). -
INVOICING_ENTITY - The name of the entity that issues the AWS invoice.
-
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
andCreateBucket
. -
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
-
PURCHASE_TYPE - The reservation type of the purchase that this usage is related to. Examples include On-Demand Instances and Standard Reserved Instances.
-
RESERVATION_ID - The unique identifier for an AWS Reservation Instance.
-
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
-
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
-
SERVICE - The AWS service such as Amazon DynamoDB.
-
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
-
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 AWS Region.
-
RECORD_TYPE - The different types of charges such as Reserved Instance (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 AWS ID of the member account.
-
PLATFORM - The Amazon 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.
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 - The payment option for the given Savings Plans (for example, All Upfront)
-
REGION - The AWS 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 AWS ID of the member account.
-
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
Type: String
Valid Values:
COST_AND_USAGE | RESERVATIONS | SAVINGS_PLANS
Required: No
-
- Dimension
-
The name of the dimension. Each
Dimension
is available for a differentContext
. For more information, seeContext
.LINK_ACCOUNT_NAME
andSERVICE_CODE
can only be used in CostCategoryRule.Type: String
Valid Values:
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
Required: Yes
- Filter
-
Use
Expression
to filter in various Cost Explorer APIs.Not all
Expression
types are supported in each API. Refer to the documentation for each specific API to see what is supported.There are two patterns:
-
Simple dimension values.
-
There are three types of simple dimension values:
CostCategories
,Tags
, andDimensions
.-
Specify the
CostCategories
field to define a filter that acts on Cost Categories. -
Specify the
Tags
field to define a filter that acts on Cost Allocation Tags. -
Specify the
Dimensions
field to define a filter that acts on theDimensionValues
.
-
-
For each filter type, you can set the dimension name and values for the filters that you plan to use.
-
For example, you can filter for
REGION==us-east-1 OR REGION==us-west-1
. ForGetRightsizingRecommendation
, the Region is a full name (for example,REGION==US East (N. Virginia)
. -
The corresponding
Expression
for this example is as follows:{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }
-
As shown in the previous example, lists of dimension values are combined with
OR
when applying the filter.
-
-
You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.
-
For example, you can filter for linked account names that start with "a".
-
The corresponding
Expression
for this example is as follows:{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }
-
-
-
Compound
Expression
types with logical operations.-
You can use multiple
Expression
types and the logical operatorsAND/OR/NOT
to create a list of one or moreExpression
objects. By doing this, you can filter by more advanced options. -
For example, you can filter by
((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)
. -
The corresponding
Expression
for this example is as follows:{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
Note
Because each
Expression
can have only one operator, the service returns an error if more than one is specified. The following example shows anExpression
object that creates an error:{ "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
The following is an example of the corresponding error message:
"Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
-
Note
For the
GetRightsizingRecommendation
action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited toLINKED_ACCOUNT
,REGION
, orRIGHTSIZING_TYPE
.For the
GetReservationPurchaseRecommendation
action, only NOT is supported. AND and OR aren't supported. Dimensions are limited toLINKED_ACCOUNT
.Type: Expression object
Required: No
-
- MaxResults
-
This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.
For
GetDimensionValues
, MaxResults has an upper limit of 1000.Type: Integer
Valid Range: Minimum value of 1.
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
[\S\s]*
Required: No
- SearchString
-
The value that you want to search the filter values for.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- SortBy
-
The value that you want to sort the data by.
The key represents cost and usage metrics. The following values are supported:
-
BlendedCost
-
UnblendedCost
-
AmortizedCost
-
NetAmortizedCost
-
NetUnblendedCost
-
UsageQuantity
-
NormalizedUsageAmount
The supported values for the
SortOrder
key areASCENDING
orDESCENDING
.When you specify a
SortBy
paramater, the context must beCOST_AND_USAGE
. Further, when usingSortBy
,NextPageToken
andSearchString
aren't supported.Type: Array of SortDefinition objects
Required: No
-
- TimePeriod
-
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
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
.Type: DateInterval object
Required: Yes
Response Syntax
{
"DimensionValues": [
{
"Attributes": {
"string" : "string"
},
"Value": "string"
}
],
"NextPageToken": "string",
"ReturnSize": number,
"TotalSize": number
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- 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 Amazon 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
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 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 Amazon 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.
-
RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service. You can opt-in by enabling
Hourly
andResource Level Data
in AWS Cost Management Console preferences.
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 AWS ID of the member account.
-
PLATFORM - The Amazon 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.
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 AWS 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 AWS ID of the member account.
-
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
Type: Array of DimensionValuesWithAttributes objects
-
- 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
[\S\s]*
- ReturnSize
-
The number of results that AWS returned at one time.
Type: Integer
- TotalSize
-
The total number of search results.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors.
- BillExpirationException
-
The requested report expired. Update the date interval and try again.
HTTP Status Code: 400
- DataUnavailableException
-
The requested data is unavailable.
HTTP Status Code: 400
- InvalidNextTokenException
-
The pagination token is invalid. Try again without a pagination token.
HTTP Status Code: 400
- LimitExceededException
-
You made too many calls in a short period of time. Try again later.
HTTP Status Code: 400
- RequestChangedException
-
Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
HTTP Status Code: 400
Examples
Example
The following is a sample request and response of the
GetDimensionValues
operation that enables you to search for all the member
accounts in an organization in AWS Organizations that have "Elastic" in their
name.
Sample Request
POST / HTTP/1.1
Host: ce.us-east-1.amazonaws.com
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSInsightsIndexService.GetDimensionValues
{
"TimePeriod": {
"Start": "2017-01-01",
"End": "2017-05-18"
},
"SearchString": "Elastic",
"Dimension": "Service"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
//Attributes are optional metadata that are returned depending on the dimension that you select.
{
"DimensionValues": [
{
"Attributes": {},
"Value": "Amazon ElastiCache"
},
{
"Attributes": {},
"Value": "EC2 - Other"
},
{
"Attributes": {},
"Value": "Amazon Elastic Compute Cloud - Compute"
},
{
"Attributes": {},
"Value": "Amazon Elasticsearch Service"
}
],
"ReturnSize": 4,
"TotalSize": 4
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: