com.amazonaws.services.costexplorer.model

Class GetDimensionValuesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.costexplorer.model.GetDimensionValuesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetDimensionValuesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetDimensionValuesRequest()

Method Summary

Modifier and Type	Method and Description
GetDimensionValuesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getContext() The context for the call to GetDimensionValues.
String	getDimension() The name of the dimension.
String	getNextPageToken() The token to retrieve the next set of results.
String	getSearchString() The value that you want to search the filter values for.
DateInterval	getTimePeriod() The start and end dates for retrieving the dimension values.
int	hashCode()
void	setContext(String context) The context for the call to GetDimensionValues.
void	setDimension(String dimension) The name of the dimension.
void	setNextPageToken(String nextPageToken) The token to retrieve the next set of results.
void	setSearchString(String searchString) The value that you want to search the filter values for.
void	setTimePeriod(DateInterval timePeriod) The start and end dates for retrieving the dimension values.
String	toString() Returns a string representation of this object.
GetDimensionValuesRequest	withContext(Context context) The context for the call to GetDimensionValues.
GetDimensionValuesRequest	withContext(String context) The context for the call to GetDimensionValues.
GetDimensionValuesRequest	withDimension(Dimension dimension) The name of the dimension.
GetDimensionValuesRequest	withDimension(String dimension) The name of the dimension.
GetDimensionValuesRequest	withNextPageToken(String nextPageToken) The token to retrieve the next set of results.
GetDimensionValuesRequest	withSearchString(String searchString) The value that you want to search the filter values for.
GetDimensionValuesRequest	withTimePeriod(DateInterval timePeriod) The start and end dates for retrieving the dimension values.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetDimensionValuesRequest

public GetDimensionValuesRequest()

Method Detail

setSearchString

public void setSearchString(String searchString)

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

Parameters:

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

getSearchString

public String getSearchString()

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

Returns:

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

withSearchString

public GetDimensionValuesRequest withSearchString(String searchString)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTimePeriod

public void setTimePeriod(DateInterval timePeriod)

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.

Parameters:

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

getTimePeriod

public DateInterval getTimePeriod()

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.

Returns:

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.

withTimePeriod

public GetDimensionValuesRequest withTimePeriod(DateInterval timePeriod)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDimension

public void setDimension(String dimension)

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

Parameters:

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

See Also:

Dimension

getDimension

public String getDimension()

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

Returns:

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

See Also:

Dimension

withDimension

public GetDimensionValuesRequest withDimension(String dimension)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Dimension

withDimension

public GetDimensionValuesRequest withDimension(Dimension dimension)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Dimension

setContext

public void setContext(String 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 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.

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

Parameters:

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

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

See Also:

Context

getContext

public String getContext()

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.

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

Returns:

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.

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

See Also:

Context

withContext

public GetDimensionValuesRequest withContext(String 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 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.

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Context

withContext

public GetDimensionValuesRequest withContext(Context 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 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.

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Context

setNextPageToken

public void setNextPageToken(String 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.

Parameters:

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.

getNextPageToken

public String getNextPageToken()

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.

Returns:

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.

withNextPageToken

public GetDimensionValuesRequest withNextPageToken(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetDimensionValuesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()