GetDimensionValuesRequest (AWS Java SDK :: Services

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:: SdkPojo, 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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetDimensionValuesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`boolean`	`equalsBySdkFields(Object obj)`
`Expression`	`filter()` Returns the value of the Filter property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSortBy()` Returns true if the SortBy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`maxResults()` This field is only used when SortBy is provided in the request.
`String`	`nextPageToken()` The token to retrieve the next set of results.
`List<SdkField<?>>`	`sdkFields()`
`String`	`searchString()` The value that you want to search the filter values for.
`static Class<? extends GetDimensionValuesRequest.Builder>`	`serializableBuilderClass()`
`List<SortDefinition>`	`sortBy()` The value by which you want to sort the data.
`DateInterval`	`timePeriod()` The start and end dates for retrieving the dimension values.
`GetDimensionValuesRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

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
  - searchString
```
public final 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 final 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 final Dimension dimension()
```
    The name of the dimension. Each Dimension is available for a different Context. 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. Each Dimension is available for a different Context. For more information, see Context.
    
    See Also:
    
    Dimension
  - dimensionAsString
```
public final String dimensionAsString()
```
    The name of the dimension. Each Dimension is available for a different Context. 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. Each Dimension is available for a different Context. For more information, see Context.
    
    See Also:
    
    Dimension
  - context
```
public final 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.
    - REGION - The AWS Region.
    - 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
    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 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.
    
    REGION - The AWS Region.
    
    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
  - contextAsString
```
public final String contextAsString()
```
    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.
    - REGION - The AWS Region.
    - 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
    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 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.
    
    REGION - The AWS Region.
    
    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
  - filter
```
public final Expression filter()
```
    Returns the value of the Filter property for this object.
    
    Returns:
    
    The value of the Filter property for this object.
  - hasSortBy
```
public final boolean hasSortBy()
```
    Returns true if the SortBy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - sortBy
```
public final List<SortDefinition> sortBy()
```
    The value by which you want to sort the data.
    
    The key represents cost and usage metrics. The following values are supported:
    - BlendedCost
    - UnblendedCost
    - AmortizedCost
    - NetAmortizedCost
    - NetUnblendedCost
    - UsageQuantity
    - NormalizedUsageAmount
    Supported values for SortOrder are ASCENDING or DESCENDING.
    
    When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSortBy() to see if a value was sent in this field.
    Returns:
    The value by which you want to sort the data.
    
    The key represents cost and usage metrics. The following values are supported:
    
    BlendedCost
    
    UnblendedCost
    
    AmortizedCost
    
    NetAmortizedCost
    
    NetUnblendedCost
    
    UsageQuantity
    
    NormalizedUsageAmount
    
    Supported values for SortOrder are ASCENDING or DESCENDING.
    
    When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.
  - maxResults
```
public final Integer maxResults()
```
    This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
    
    For GetDimensionValues, MaxResults has an upper limit of 1000.
    
    Returns:
    
    This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
    
    For GetDimensionValues, MaxResults has an upper limit of 1000.
  - nextPageToken
```
public final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetDimensionValuesRequest.Builder,GetDimensionValuesRequest>
    
    Specified by:
    
    toBuilder in class CostExplorerRequest
  - builder
```
public static GetDimensionValuesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetDimensionValuesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetDimensionValuesRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

searchString

timePeriod

dimension

dimensionAsString

context

contextAsString

filter

hasSortBy

sortBy

maxResults

nextPageToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields