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>

  • Method Details

    • 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 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 date and end date 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. LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

      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. LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.
      See Also:

    • dimensionAsString

      public final String dimensionAsString()

      The name of the dimension. Each Dimension is available for a different Context. For more information, see Context. LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

      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. LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.
      See Also:

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

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

        - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services 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 SingleAZ and MultiAZ.

      • 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, and C7g), Memory Optimization (for example, R4, R5n, R5b, and R6g).

      • 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 RunInstance and CreateBucket.

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

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

        - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services 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 SingleAZ and MultiAZ.

      • 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, and C7g), Memory Optimization (for example, R4, R5n, R5b, and R6g).

      • 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 RunInstance and CreateBucket .

      • 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 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 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 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 - 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:

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

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

        - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services 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 SingleAZ and MultiAZ.

      • 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, and C7g), Memory Optimization (for example, R4, R5n, R5b, and R6g).

      • 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 RunInstance and CreateBucket.

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

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

        - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services 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 SingleAZ and MultiAZ.

      • 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, and C7g), Memory Optimization (for example, R4, R5n, R5b, and R6g).

      • 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 RunInstance and CreateBucket .

      • 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 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 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 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 - 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:

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

    • 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 SortOrder key are ASCENDING or DESCENDING.

      When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString aren'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 SortOrder key are ASCENDING or DESCENDING.

      When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString aren't supported.

    • billingViewArn

      public final String billingViewArn()

      The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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

    • sdkFields

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.