Class ProductAttributeValues

java.lang.Object
software.amazon.awssdk.services.costexplorer.model.ProductAttributeValues
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ProductAttributeValues.Builder,ProductAttributeValues>

@Generated("software.amazon.awssdk:codegen") public final class ProductAttributeValues extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProductAttributeValues.Builder,ProductAttributeValues>

The product attribute values that you can use to filter the costs of supported services. Currently, Amazon Bedrock is the only supported service.

The following product attribute keys are available for each supported service:

  • Amazon Bedrock

    • provider - The model provider, such as Anthropic, Cohere, or OpenAI.

    • model - The model, such as Claude Sonnet 5 or Claude Haiku 4.5.

    • inferenceType - The type of inference usage, such as Input tokens or Output tokens.

    • feature - The feature that was used, such as On-demand Inference or Reranker.

The following operations support product attributes: GetCostAndUsage, GetCostAndUsageWithResources, GetDimensionValues (in the COST_AND_USAGE context), GetTags, and GetCostCategories.

Product attribute data is available for time periods that start on or after September 1, 2026. Requests for earlier time periods that use product attributes fail with a DataUnavailableException.

The SERVICE filter rules for product attributes depend on the operation:

  • GetCostAndUsage and GetCostAndUsageWithResources - Optional.

  • GetDimensionValues - Required when the filter includes ProductAttributes, for any Dimension. Otherwise, optional.

  • GetTags and GetCostCategories - Required when the filter includes ProductAttributes.

A SERVICE filter must contain only supported services, or the request fails with a ValidationException. Service names are matched exactly. To list them, use GetDimensionValues with Dimension set to SERVICE and the same TimePeriod, for example with SearchString set to Bedrock.

The costs of a supported service can appear under multiple service names. When the SERVICE filter is optional, omit it so that your results include all of those costs.

For example, the following Expression filters for the costs of one model: { "ProductAttributes": { "Key": "model", "Values": [ "Claude Sonnet 5" ], "MatchOptions": [ "EQUALS" ] } }

See Also:
  • Method Details

    • key

      public final String key()

      The name of the product attribute, such as model. The keys that are available depend on the service. For the keys of each supported service, see ProductAttributeValues .

      Keys are case-sensitive. A key that doesn't exist doesn't return an error: EQUALS matches no costs, and ABSENT matches all costs of supported services.

      Returns:
      The name of the product attribute, such as model. The keys that are available depend on the service. For the keys of each supported service, see ProductAttributeValues .

      Keys are case-sensitive. A key that doesn't exist doesn't return an error: EQUALS matches no costs, and ABSENT matches all costs of supported services.

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values 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.
    • values

      public final List<String> values()

      The specific values of the product attribute, such as Claude Sonnet 5 for the model key. Values are matched exactly, including case. To list the values of a key, use GetDimensionValues with Dimension set to PRODUCT_ATTRIBUTE and DimensionKey set to the key.

      To match costs that have no value for the key, set MatchOptions to ABSENT and omit Values. Otherwise, Values is required.

      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 hasValues() method.

      Returns:
      The specific values of the product attribute, such as Claude Sonnet 5 for the model key. Values are matched exactly, including case. To list the values of a key, use GetDimensionValues with Dimension set to PRODUCT_ATTRIBUTE and DimensionKey set to the key.

      To match costs that have no value for the key, set MatchOptions to ABSENT and omit Values. Otherwise, Values is required.

    • matchOptions

      public final List<MatchOption> matchOptions()

      The match options that you can use to filter your results. Valid values:

      • EQUALS - Matches the values that you specify.

      • ABSENT - Matches costs that have no value for the key. Omit Values.

      • CASE_SENSITIVE - Use only with EQUALS. Values are always matched case-sensitively.

      Default values are EQUALS and CASE_SENSITIVE.

      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 hasMatchOptions() method.

      Returns:
      The match options that you can use to filter your results. Valid values:

      • EQUALS - Matches the values that you specify.

      • ABSENT - Matches costs that have no value for the key. Omit Values.

      • CASE_SENSITIVE - Use only with EQUALS. Values are always matched case-sensitively.

      Default values are EQUALS and CASE_SENSITIVE.

    • hasMatchOptions

      public final boolean hasMatchOptions()
      For responses, this returns true if the service returned a value for the MatchOptions 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.
    • matchOptionsAsStrings

      public final List<String> matchOptionsAsStrings()

      The match options that you can use to filter your results. Valid values:

      • EQUALS - Matches the values that you specify.

      • ABSENT - Matches costs that have no value for the key. Omit Values.

      • CASE_SENSITIVE - Use only with EQUALS. Values are always matched case-sensitively.

      Default values are EQUALS and CASE_SENSITIVE.

      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 hasMatchOptions() method.

      Returns:
      The match options that you can use to filter your results. Valid values:

      • EQUALS - Matches the values that you specify.

      • ABSENT - Matches costs that have no value for the key. Omit Values.

      • CASE_SENSITIVE - Use only with EQUALS. Values are always matched case-sensitively.

      Default values are EQUALS and CASE_SENSITIVE.

    • toBuilder

      public ProductAttributeValues.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<ProductAttributeValues.Builder,ProductAttributeValues>
      Returns:
      a builder for type T
    • builder

      public static ProductAttributeValues.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ProductAttributeValues.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.