AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetDimensionValuesInput

import "github.com/aws/aws-sdk-go/service/costexplorer"

type GetDimensionValuesInput struct { Context *string `type:"string" enum:"Context"` Dimension *string `type:"string" required:"true" enum:"Dimension"` NextPageToken *string `type:"string"` SearchString *string `type:"string"` TimePeriod *DateInterval `type:"structure" required:"true"` }

Context

Type: *string

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

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

Dimension

Type: *string

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

Dimension is a required field

NextPageToken

Type: *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.

SearchString

Type: *string

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

TimePeriod

The time period that you want the usage and costs for.

Method

GoString

func (s GetDimensionValuesInput) GoString() string

GoString returns the string representation

SetContext

func (s *GetDimensionValuesInput) SetContext(v string) *GetDimensionValuesInput

SetContext sets the Context field's value.

SetDimension

func (s *GetDimensionValuesInput) SetDimension(v string) *GetDimensionValuesInput

SetDimension sets the Dimension field's value.

SetNextPageToken

func (s *GetDimensionValuesInput) SetNextPageToken(v string) *GetDimensionValuesInput

SetNextPageToken sets the NextPageToken field's value.

SetSearchString

func (s *GetDimensionValuesInput) SetSearchString(v string) *GetDimensionValuesInput

SetSearchString sets the SearchString field's value.

SetTimePeriod

func (s *GetDimensionValuesInput) SetTimePeriod(v *DateInterval) *GetDimensionValuesInput

SetTimePeriod sets the TimePeriod field's value.

String

func (s GetDimensionValuesInput) String() string

String returns the string representation

Validate

func (s *GetDimensionValuesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: