Get Dimension Values
costexplorer_get_dimension_values | R Documentation |
Retrieves all available filter values for a specified filter over a period of time¶
Description¶
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
Usage¶
costexplorer_get_dimension_values(SearchString, TimePeriod, Dimension,
Context, Filter, SortBy, BillingViewArn, MaxResults, NextPageToken)
Arguments¶
SearchString |
The value that you want to search the filter values for. |
TimePeriod |
[required] 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 |
Dimension |
[required] The name of the dimension. Each |
Context |
The context for the call to If you set the context to
If you set the context to
If you set the context to
|
Filter |
|
SortBy |
The value that you want to sort the data by. The key represents cost and usage metrics. The following values are supported:
The supported values for the When you specify a |
BillingViewArn |
The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API. |
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 |
NextPageToken |
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. |
Value¶
A list with the following syntax:
list(
DimensionValues = list(
list(
Value = "string",
Attributes = list(
"string"
)
)
),
ReturnSize = 123,
TotalSize = 123,
NextPageToken = "string"
)
Request syntax¶
svc$get_dimension_values(
SearchString = "string",
TimePeriod = list(
Start = "string",
End = "string"
),
Dimension = "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",
Context = "COST_AND_USAGE"|"RESERVATIONS"|"SAVINGS_PLANS",
Filter = list(
Or = list(
list()
),
And = list(
list()
),
Not = list(),
Dimensions = list(
Key = "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",
Values = list(
"string"
),
MatchOptions = list(
"EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
)
),
Tags = list(
Key = "string",
Values = list(
"string"
),
MatchOptions = list(
"EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
)
),
CostCategories = list(
Key = "string",
Values = list(
"string"
),
MatchOptions = list(
"EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
)
)
),
SortBy = list(
list(
Key = "string",
SortOrder = "ASCENDING"|"DESCENDING"
)
),
BillingViewArn = "string",
MaxResults = 123,
NextPageToken = "string"
)