software.amazon.awssdk.services.costexplorer.model

Class GetDimensionValuesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest

software.amazon.awssdk.services.costexplorer.model.GetDimensionValuesRequest

All Implemented Interfaces:

ToCopyableBuilder<GetDimensionValuesRequest.Builder,GetDimensionValuesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDimensionValuesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetDimensionValuesRequest.Builder	builder()
Context	context() The context for the call to GetDimensionValues.
String	contextAsString() The context for the call to GetDimensionValues.
Dimension	dimension() The name of the dimension.
String	dimensionAsString() The name of the dimension.
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 SdkRequest.
int	hashCode()
String	nextPageToken() The token to retrieve the next set of results.
String	searchString() The value that you want to search the filter values for.
static Class<? extends GetDimensionValuesRequest.Builder>	serializableBuilderClass()
DateInterval	timePeriod() The start and end dates for retrieving the dimension values.
GetDimensionValuesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

searchString

public String searchString()

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

Returns:

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

timePeriod

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

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.

dimension

public Dimension dimension()

The name of the dimension. Different Dimensionsare available for different Contexts. For more information, see Context.

If the service returns an enum value that is not available in the current SDK version, dimension will return Dimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dimensionAsString().

Returns:

The name of the dimension. Different Dimensionsare available for different Contexts. For more information, see Context.

See Also:

Dimension

dimensionAsString

public String dimensionAsString()

The name of the dimension. Different Dimensionsare available for different Contexts. For more information, see Context.

If the service returns an enum value that is not available in the current SDK version, dimension will return Dimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dimensionAsString().

Returns:

The name of the dimension. Different Dimensionsare available for different Contexts. For more information, see Context.

See Also:

Dimension

context

public Context context()

The context for the call to GetDimensionValues. This can be RESERVED_INSTANCE or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVED_INSTANCE, the resulting dimension values can be used in the GetReservationUtilization action. 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 CostAndUsage, you can use the following dimensions for searching:

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

• InstanceType - The type of 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

• Operation - The action performed. Examples include RunInstance and CreateBucket.

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

• UsageType -The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues action includes a unit attribute, examples of which include GB and Hrs.

• UsageTypeGroup - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this action includes a unit attribute.

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

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

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

• InstanceType - The type of 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 operating system. Examples are Windows or Linux.

• Region - The AWS region.

• Scope - The scope of a reserved instance (RI). Values are regional or a single availability zone.

• Tenancy - The tenancy of a resource. Examples are shared or dedicated.

If the service returns an enum value that is not available in the current SDK version, context will return Context.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contextAsString().

Returns:

The context for the call to GetDimensionValues. This can be RESERVED_INSTANCE or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVED_INSTANCE, the resulting dimension values can be used in the GetReservationUtilization action. 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 CostAndUsage, you can use the following dimensions for searching:

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

• InstanceType - The type of 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

• Operation - The action performed. Examples include RunInstance and CreateBucket.

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

• UsageType -The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues action includes a unit attribute, examples of which include GB and Hrs.

• UsageTypeGroup - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this action includes a unit attribute.

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

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

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

• InstanceType - The type of 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 operating system. Examples are Windows or Linux.

• Region - The AWS region.

• Scope - The scope of a reserved instance (RI). Values are regional or a single availability zone.

• Tenancy - The tenancy of a resource. Examples are shared or dedicated.

See Also:

Context

contextAsString

public String contextAsString()

The context for the call to GetDimensionValues. This can be RESERVED_INSTANCE or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVED_INSTANCE, the resulting dimension values can be used in the GetReservationUtilization action. 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 CostAndUsage, you can use the following dimensions for searching:

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

• InstanceType - The type of 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

• Operation - The action performed. Examples include RunInstance and CreateBucket.

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

• UsageType -The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues action includes a unit attribute, examples of which include GB and Hrs.

• UsageTypeGroup - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this action includes a unit attribute.

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

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

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

• InstanceType - The type of 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 operating system. Examples are Windows or Linux.

• Region - The AWS region.

• Scope - The scope of a reserved instance (RI). Values are regional or a single availability zone.

• Tenancy - The tenancy of a resource. Examples are shared or dedicated.

If the service returns an enum value that is not available in the current SDK version, context will return Context.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contextAsString().

Returns:

The context for the call to GetDimensionValues. This can be RESERVED_INSTANCE or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVED_INSTANCE, the resulting dimension values can be used in the GetReservationUtilization action. 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 CostAndUsage, you can use the following dimensions for searching:

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

• InstanceType - The type of 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

• Operation - The action performed. Examples include RunInstance and CreateBucket.

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

• UsageType -The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues action includes a unit attribute, examples of which include GB and Hrs.

• UsageTypeGroup - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this action includes a unit attribute.

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

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

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

• InstanceType - The type of 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 operating system. Examples are Windows or Linux.

• Region - The AWS region.

• Scope - The scope of a reserved instance (RI). Values are regional or a single availability zone.

• Tenancy - The tenancy of a resource. Examples are shared or dedicated.

See Also:

Context

nextPageToken

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

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.

toBuilder

public GetDimensionValuesRequest.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<GetDimensionValuesRequest.Builder,GetDimensionValuesRequest>

Specified by:

toBuilder in class CostExplorerRequest

Returns:

a builder for type T

builder

public static GetDimensionValuesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDimensionValuesRequest.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: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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