software.amazon.awssdk.services.costexplorer.model

Class GetDimensionValuesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.costexplorer.model.CostExplorerResponse

software.amazon.awssdk.services.costexplorer.model.GetDimensionValuesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDimensionValuesResponse.Builder,GetDimensionValuesResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetDimensionValuesResponse
extends CostExplorerResponse
implements ToCopyableBuilder<GetDimensionValuesResponse.Builder,GetDimensionValuesResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDimensionValuesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetDimensionValuesResponse.Builder	builder()
List<DimensionValuesWithAttributes>	dimensionValues() The filters that you used to filter your request.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	nextPageToken() The token for the next set of retrievable results.
Integer	returnSize() The number of results that AWS returned at one time.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDimensionValuesResponse.Builder>	serializableBuilderClass()
GetDimensionValuesResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	totalSize() The total number of search results.

Methods inherited from class software.amazon.awssdk.services.costexplorer.model.CostExplorerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dimensionValues

public List<DimensionValuesWithAttributes> dimensionValues()

The filters that you used to filter your request. Some dimensions are available only for a specific context.

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The filters that you used to filter your request. Some dimensions are available only for a specific context.

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.

returnSize

public Integer returnSize()

The number of results that AWS returned at one time.

Returns:

The number of results that AWS returned at one time.

totalSize

public Integer totalSize()

The total number of search results.

Returns:

The total number of search results.

nextPageToken

public String nextPageToken()

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Returns:

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

toBuilder

public GetDimensionValuesResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetDimensionValuesResponse.Builder,GetDimensionValuesResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetDimensionValuesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetDimensionValuesResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.