class Aws::CostExplorer::Types::GetDimensionValuesRequest
@note When making an API call, you may pass GetDimensionValuesRequest
data as a hash: { search_string: "SearchString", time_period: { # required start: "YearMonthDay", # required end: "YearMonthDay", # required }, dimension: "AZ", # required, accepts 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 context: "COST_AND_USAGE", # accepts COST_AND_USAGE, RESERVATIONS, SAVINGS_PLANS filter: { or: [ { # recursive Expression }, ], and: [ { # recursive Expression }, ], not: { # recursive Expression }, dimensions: { key: "AZ", # accepts 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 values: ["Value"], match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE }, tags: { key: "TagKey", values: ["Value"], match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE }, cost_categories: { key: "CostCategoryName", values: ["Value"], match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE }, }, sort_by: [ { key: "SortDefinitionKey", # required sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING }, ], max_results: 1, next_page_token: "NextPageToken", }
@!attribute [rw] search_string
The value that you want to search the filter values for. @return [String]
@!attribute [rw] time_period
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`. @return [Types::DateInterval]
@!attribute [rw] dimension
The name of the dimension. Each `Dimension` is available for a different `Context`. For more information, see `Context`. @return [String]
@!attribute [rw] 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 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` and `CreateBucket`. * 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` and `MultiAZ`. * 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 @return [String]
@!attribute [rw] filter
Use `Expression` to filter by cost or by usage. There are two patterns: * Simple dimension values - 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`. For `GetRightsizingRecommendation`, the Region is a full name (for example, `REGION==US East (N. Virginia)`. The `Expression` example is as follows: `\{ "Dimensions": \{ "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] \} \}` The list of dimension values are OR'd together to retrieve cost or usage data. You can create `Expression` and `DimensionValues` objects using either `with*` methods or `set*` methods in multiple lines. * Compound dimension values with logical operations - You can use multiple `Expression` types and the logical operators `AND/OR/NOT` to create a list of one or more `Expression` objects. By doing this, you can filter on more advanced options. For example, you can filter on `((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)`. The `Expression` for that 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 markdown="1"> Because each `Expression` can have only one operator, the service returns an error if more than one is specified. The following example shows an `Expression` object that creates an error. </note> ` \{ "And": [ ... ], "DimensionValues": \{ "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] \} \} ` <note markdown="1"> 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 to `LINKED_ACCOUNT`, `REGION`, or `RIGHTSIZING_TYPE`. For the `GetReservationPurchaseRecommendation` action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to `LINKED_ACCOUNT`. </note> @return [Types::Expression]
@!attribute [rw] sort_by
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. @return [Array<Types::SortDefinition>]
@!attribute [rw] max_results
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. @return [Integer]
@!attribute [rw] next_page_token
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. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetDimensionValuesRequest AWS API Documentation
Constants
- SENSITIVE