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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensionValues() For responses, this returns true if the service returned a value for the DimensionValues property.
int	hashCode()
String	nextPageToken() The token for the next set of retrievable results.
Integer	returnSize() The number of results that Amazon Web Services returned at one time.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDimensionValuesResponse.Builder>	serializableBuilderClass()
GetDimensionValuesResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasDimensionValues

public final boolean hasDimensionValues()

For responses, this returns true if the service returned a value for the DimensionValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

dimensionValues

public final 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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. You can opt-in by enabling Hourly and Resource Level Data in Cost Management Console preferences.

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 Amazon Web Services ID of the member account.

• PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

• REGION - The Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services ID of the member account.

• SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensionValues() method.

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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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. You can opt-in by enabling Hourly and Resource Level Data in Cost Management Console preferences.

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 Amazon Web Services ID of the member account.

• PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

• REGION - The Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services ID of the member account.

• SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

returnSize

public final Integer returnSize()

The number of results that Amazon Web Services returned at one time.

Returns:

The number of results that Amazon Web Services returned at one time.

totalSize

public final Integer totalSize()

The total number of search results.

Returns:

The total number of search results.

nextPageToken

public final String nextPageToken()

The token for the next set of retrievable results. Amazon Web Services 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. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

toBuilder

public GetDimensionValuesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDimensionValuesResponse.Builder,GetDimensionValuesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetDimensionValuesResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo