Package software.amazon.awssdk.services.bedrock.model

Class CreateProvisionedModelThroughputRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrock.model.BedrockRequest

software.amazon.awssdk.services.bedrock.model.CreateProvisionedModelThroughputRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateProvisionedModelThroughputRequest.Builder,CreateProvisionedModelThroughputRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateProvisionedModelThroughputRequest
extends BedrockRequest
implements ToCopyableBuilder<CreateProvisionedModelThroughputRequest.Builder,CreateProvisionedModelThroughputRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateProvisionedModelThroughputRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateProvisionedModelThroughputRequest.Builder	builder()
String	clientRequestToken()	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CommitmentDuration	commitmentDuration()	The commitment duration requested for the Provisioned Throughput.
String	commitmentDurationAsString()	The commitment duration requested for the Provisioned Throughput.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	modelId()	The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput.
Integer	modelUnits()	Number of model units to allocate.
String	provisionedModelName()	The name for this Provisioned Throughput.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateProvisionedModelThroughputRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Tags to associate with this Provisioned Throughput.
CreateProvisionedModelThroughputRequest.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

clientRequestToken

public final String clientRequestToken()

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

Returns:

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

modelUnits

public final Integer modelUnits()

Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.

For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.

For more information about what an MU specifies, contact your Amazon Web Services account manager.

Returns:

Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.

For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.

For more information about what an MU specifies, contact your Amazon Web Services account manager.

provisionedModelName

public final String provisionedModelName()

The name for this Provisioned Throughput.

Returns:

The name for this Provisioned Throughput.

modelId

public final String modelId()

The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.

Returns:

The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.

commitmentDuration

public final CommitmentDuration commitmentDuration()

The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.

Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide

If the service returns an enum value that is not available in the current SDK version, commitmentDuration will return CommitmentDuration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from commitmentDurationAsString().

Returns:

The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.

Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide

See Also:

CommitmentDuration

commitmentDurationAsString

public final String commitmentDurationAsString()

The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.

Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide

If the service returns an enum value that is not available in the current SDK version, commitmentDuration will return CommitmentDuration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from commitmentDurationAsString().

Returns:

The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.

Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide

See Also:

CommitmentDuration

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

Tags to associate with this Provisioned Throughput.

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

Returns:

Tags to associate with this Provisioned Throughput.

toBuilder

public CreateProvisionedModelThroughputRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateProvisionedModelThroughputRequest.Builder,CreateProvisionedModelThroughputRequest>

Specified by:

toBuilder in class BedrockRequest

builder

public static CreateProvisionedModelThroughputRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateProvisionedModelThroughputRequest.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