logo
pub struct GetDimensionValuesRequest {
    pub context: Option<String>,
    pub dimension: String,
    pub filter: Option<Expression>,
    pub max_results: Option<i64>,
    pub next_page_token: Option<String>,
    pub search_string: Option<String>,
    pub sort_by: Option<Vec<SortDefinition>>,
    pub time_period: DateInterval,
}

Fields

context: Option<String>

The context for the call to GetDimensionValues. This can be RESERVATIONS or COSTANDUSAGE. The default value is COSTANDUSAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COSTANDUSAGE, the resulting dimension values can be used in the GetCostAndUsage operation.

If you set the context to COSTANDUSAGE, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • DATABASEENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

  • INSTANCETYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LEGALENTITYNAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

  • LINKEDACCOUNT - 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.

  • OPERATINGSYSTEM - 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.

  • PURCHASETYPE - 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.

  • USAGETYPE - 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.

  • USAGETYPEGROUP - 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.

  • RECORDTYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

  • RESOURCEID - 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.

  • CACHEENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

  • DEPLOYMENTOPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

  • INSTANCETYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LINKEDACCOUNT - 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 SAVINGSPLANS, you can use the following dimensions for searching:

  • SAVINGSPLANSTYPE - Type of Savings Plans (EC2 Instance or Compute)

  • PAYMENTOPTION - Payment option for the given Savings Plans (for example, All Upfront)

  • REGION - The AWS Region.

  • INSTANCETYPEFAMILY - The family of instances (For example, m5)

  • LINKEDACCOUNT - 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.

  • SAVINGSPLAN_ARN - The unique identifier for your Savings Plan

dimension: String

The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.

filter: Option<Expression>max_results: Option<i64>

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.

next_page_token: Option<String>

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.

search_string: Option<String>

The value that you want to search the filter values for.

sort_by: Option<Vec<SortDefinition>>

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.

time_period: DateInterval

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.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more