Class ProductAttributeValues
- All Implemented Interfaces:
Serializable,SdkPojo,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 asAnthropic,Cohere, orOpenAI. -
model- The model, such asClaude Sonnet 5orClaude Haiku 4.5. -
inferenceType- The type of inference usage, such asInput tokensorOutput tokens. -
feature- The feature that was used, such asOn-demand InferenceorReranker.
-
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:
-
GetCostAndUsageandGetCostAndUsageWithResources- Optional. -
GetDimensionValues- Required when the filter includesProductAttributes, for anyDimension. Otherwise, optional. -
GetTagsandGetCostCategories- Required when the filter includesProductAttributes.
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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final booleanFor responses, this returns true if the service returned a value for the MatchOptions property.final booleanFor responses, this returns true if the service returned a value for the Values property.final Stringkey()The name of the product attribute, such asmodel.final List<MatchOption> The match options that you can use to filter your results.The match options that you can use to filter your results.static Class<? extends ProductAttributeValues.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.values()The specific values of the product attribute, such asClaude Sonnet 5for themodelkey.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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, seeProductAttributeValues.Keys are case-sensitive. A key that doesn't exist doesn't return an error:
EQUALSmatches no costs, andABSENTmatches 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, seeProductAttributeValues.Keys are case-sensitive. A key that doesn't exist doesn't return an error:
EQUALSmatches no costs, andABSENTmatches 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 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. -
values
The specific values of the product attribute, such as
Claude Sonnet 5for themodelkey. Values are matched exactly, including case. To list the values of a key, useGetDimensionValueswithDimensionset toPRODUCT_ATTRIBUTEandDimensionKeyset to the key.To match costs that have no value for the key, set
MatchOptionstoABSENTand omitValues. Otherwise,Valuesis 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 5for themodelkey. Values are matched exactly, including case. To list the values of a key, useGetDimensionValueswithDimensionset toPRODUCT_ATTRIBUTEandDimensionKeyset to the key.To match costs that have no value for the key, set
MatchOptionstoABSENTand omitValues. Otherwise,Valuesis required.
-
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. OmitValues. -
CASE_SENSITIVE- Use only withEQUALS. Values are always matched case-sensitively.
Default values are
EQUALSandCASE_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. OmitValues. -
CASE_SENSITIVE- Use only withEQUALS. Values are always matched case-sensitively.
Default values are
EQUALSandCASE_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 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. -
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. OmitValues. -
CASE_SENSITIVE- Use only withEQUALS. Values are always matched case-sensitively.
Default values are
EQUALSandCASE_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. OmitValues. -
CASE_SENSITIVE- Use only withEQUALS. Values are always matched case-sensitively.
Default values are
EQUALSandCASE_SENSITIVE. -
-
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ProductAttributeValues.Builder,ProductAttributeValues> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-