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:
SdkPojo,ToCopyableBuilder<GetDimensionValuesRequest.Builder,GetDimensionValuesRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetDimensionValuesRequest extends CostExplorerRequest implements ToCopyableBuilder<GetDimensionValuesRequest.Builder,GetDimensionValuesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetDimensionValuesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetDimensionValuesRequest.Builderbuilder()Contextcontext()The context for the call toGetDimensionValues.StringcontextAsString()The context for the call toGetDimensionValues.Dimensiondimension()The name of the dimension.StringdimensionAsString()The name of the dimension.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Expressionfilter()Returns the value of the Filter property for this object.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSortBy()For responses, this returns true if the service returned a value for the SortBy property.IntegermaxResults()This field is only used when SortBy is provided in the request.StringnextPageToken()The token to retrieve the next set of results.List<SdkField<?>>sdkFields()StringsearchString()The value that you want to search the filter values for.static Class<? extends GetDimensionValuesRequest.Builder>serializableBuilderClass()List<SortDefinition>sortBy()The value that you want to sort the data by.DateIntervaltimePeriod()The start date and end date for retrieving the dimension values.GetDimensionValuesRequest.BuildertoBuilder()StringtoString()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 date and end date for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if
startis2017-01-01andendis2017-05-01, then the cost and usage data is retrieved from2017-01-01up to and including2017-04-30but not including2017-05-01.- Returns:
- The start date and end date for retrieving the dimension values. The start date is inclusive, but the end
date is exclusive. For example, if
startis2017-01-01andendis2017-05-01, then the cost and usage data is retrieved from2017-01-01up to and including2017-04-30but not including2017-05-01.
-
dimension
public final Dimension dimension()
The name of the dimension. Each
Dimensionis available for a differentContext. For more information, seeContext.LINK_ACCOUNT_NAMEandSERVICE_CODEcan only be used in CostCategoryRule.If the service returns an enum value that is not available in the current SDK version,
dimensionwill returnDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdimensionAsString().- Returns:
- The name of the dimension. Each
Dimensionis available for a differentContext. For more information, seeContext.LINK_ACCOUNT_NAMEandSERVICE_CODEcan only be used in CostCategoryRule. - See Also:
Dimension
-
dimensionAsString
public final String dimensionAsString()
The name of the dimension. Each
Dimensionis available for a differentContext. For more information, seeContext.LINK_ACCOUNT_NAMEandSERVICE_CODEcan only be used in CostCategoryRule.If the service returns an enum value that is not available in the current SDK version,
dimensionwill returnDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdimensionAsString().- Returns:
- The name of the dimension. Each
Dimensionis available for a differentContext. For more information, seeContext.LINK_ACCOUNT_NAMEandSERVICE_CODEcan only be used in CostCategoryRule. - See Also:
Dimension
-
context
public final Context context()
The context for the call to
GetDimensionValues. This can beRESERVATIONSorCOST_AND_USAGE. The default value isCOST_AND_USAGE. If the context is set toRESERVATIONS, the resulting dimension values can be used in theGetReservationUtilizationoperation. If the context is set toCOST_AND_USAGE, the resulting dimension values can be used in theGetCostAndUsageoperation.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. -
BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:
- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.
- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services in India.
- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on Amazon Web Services by third-party software providers.
-
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
SingleAZandMultiAZ. -
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. -
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are
Compute Optimized(for example,C4,C5,C6g, andC7g),Memory Optimization(for example,R4,R5n,R5b, andR6g). -
INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services invoice.
-
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
RunInstanceandCreateBucket. -
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
-
PURCHASE_TYPE - The reservation type of the purchase that this usage is related to. Examples include On-Demand Instances and Standard Reserved Instances.
-
RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.
-
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
-
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
-
SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
-
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
-
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
GetDimensionValuesoperation 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 Amazon Web Services Region.
-
RECORD_TYPE - The different types of charges such as Reserved Instance (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
SingleAZandMultiAZ. -
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 - The 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 Plans.
If the service returns an enum value that is not available in the current SDK version,
contextwill returnContext.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcontextAsString().- Returns:
- The context for the call to
GetDimensionValues. This can beRESERVATIONSorCOST_AND_USAGE. The default value isCOST_AND_USAGE. If the context is set toRESERVATIONS, the resulting dimension values can be used in theGetReservationUtilizationoperation. If the context is set toCOST_AND_USAGE, the resulting dimension values can be used in theGetCostAndUsageoperation.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. -
BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:
- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.
- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services in India.
- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on Amazon Web Services by third-party software providers.
-
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
SingleAZandMultiAZ. -
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. -
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are
Compute Optimized(for example,C4,C5,C6g, andC7g),Memory Optimization(for example,R4,R5n,R5b, andR6g). -
INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services invoice.
-
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
RunInstanceandCreateBucket. -
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
-
PURCHASE_TYPE - The reservation type of the purchase that this usage is related to. Examples include On-Demand Instances and Standard Reserved Instances.
-
RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.
-
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
-
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
-
SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
-
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
-
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
GetDimensionValuesoperation 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 Amazon Web Services Region.
-
RECORD_TYPE - The different types of charges such as Reserved Instance (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
SingleAZandMultiAZ. -
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 - The 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 Plans.
-
- See Also:
Context
-
-
contextAsString
public final String contextAsString()
The context for the call to
GetDimensionValues. This can beRESERVATIONSorCOST_AND_USAGE. The default value isCOST_AND_USAGE. If the context is set toRESERVATIONS, the resulting dimension values can be used in theGetReservationUtilizationoperation. If the context is set toCOST_AND_USAGE, the resulting dimension values can be used in theGetCostAndUsageoperation.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. -
BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:
- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.
- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services in India.
- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on Amazon Web Services by third-party software providers.
-
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
SingleAZandMultiAZ. -
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. -
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are
Compute Optimized(for example,C4,C5,C6g, andC7g),Memory Optimization(for example,R4,R5n,R5b, andR6g). -
INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services invoice.
-
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
RunInstanceandCreateBucket. -
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
-
PURCHASE_TYPE - The reservation type of the purchase that this usage is related to. Examples include On-Demand Instances and Standard Reserved Instances.
-
RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.
-
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
-
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
-
SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
-
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
-
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
GetDimensionValuesoperation 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 Amazon Web Services Region.
-
RECORD_TYPE - The different types of charges such as Reserved Instance (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
SingleAZandMultiAZ. -
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 - The 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 Plans.
If the service returns an enum value that is not available in the current SDK version,
contextwill returnContext.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcontextAsString().- Returns:
- The context for the call to
GetDimensionValues. This can beRESERVATIONSorCOST_AND_USAGE. The default value isCOST_AND_USAGE. If the context is set toRESERVATIONS, the resulting dimension values can be used in theGetReservationUtilizationoperation. If the context is set toCOST_AND_USAGE, the resulting dimension values can be used in theGetCostAndUsageoperation.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. -
BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:
- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.
- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services in India.
- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on Amazon Web Services by third-party software providers.
-
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
SingleAZandMultiAZ. -
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. -
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are
Compute Optimized(for example,C4,C5,C6g, andC7g),Memory Optimization(for example,R4,R5n,R5b, andR6g). -
INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services invoice.
-
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
RunInstanceandCreateBucket. -
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
-
PURCHASE_TYPE - The reservation type of the purchase that this usage is related to. Examples include On-Demand Instances and Standard Reserved Instances.
-
RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.
-
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
-
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
-
SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
-
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
-
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
GetDimensionValuesoperation 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 Amazon Web Services Region.
-
RECORD_TYPE - The different types of charges such as Reserved Instance (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
SingleAZandMultiAZ. -
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 - The 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 Plans.
-
- 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()
For responses, this returns true if the service returned a value for the SortBy property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
sortBy
public final List<SortDefinition> sortBy()
The value that you want to sort the data by.
The key represents cost and usage metrics. The following values are supported:
-
BlendedCost -
UnblendedCost -
AmortizedCost -
NetAmortizedCost -
NetUnblendedCost -
UsageQuantity -
NormalizedUsageAmount
The supported values for the
SortOrderkey areASCENDINGorDESCENDING.When you specify a
SortByparamater, the context must beCOST_AND_USAGE. Further, when usingSortBy,NextPageTokenandSearchStringaren't supported.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
hasSortBy()method.- Returns:
- The value that you want to sort the data by.
The key represents cost and usage metrics. The following values are supported:
-
BlendedCost -
UnblendedCost -
AmortizedCost -
NetAmortizedCost -
NetUnblendedCost -
UsageQuantity -
NormalizedUsageAmount
The supported values for the
SortOrderkey areASCENDINGorDESCENDING.When you specify a
SortByparamater, the context must beCOST_AND_USAGE. Further, when usingSortBy,NextPageTokenandSearchStringaren't supported. -
-
-
maxResults
public final Integer maxResults()
This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 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 are
returned for this request. If MaxResults isn't specified with SortBy, the request returns 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. Amazon Web Services 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. Amazon Web Services 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:
toBuilderin interfaceToCopyableBuilder<GetDimensionValuesRequest.Builder,GetDimensionValuesRequest>- Specified by:
toBuilderin classCostExplorerRequest
-
builder
public static GetDimensionValuesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetDimensionValuesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-