create_provisioned_model_throughput¶
Operation¶
create_provisioned_model_throughput
¶
create_provisioned_model_throughput(request: CreateProvisionedModelThroughputInput | CreateProvisionedModelThroughputInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateProvisionedModelThroughputInputDict]) -> CreateProvisionedModelThroughputOutput
Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateProvisionedModelThroughputInput | CreateProvisionedModelThroughputInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateProvisionedModelThroughputInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateProvisionedModelThroughputOutput
|
An instance of |
create_provisioned_model_throughput
async
¶
create_provisioned_model_throughput(request: CreateProvisionedModelThroughputInput | CreateProvisionedModelThroughputInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateProvisionedModelThroughputInputDict]) -> CreateProvisionedModelThroughputOutput
Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateProvisionedModelThroughputInput | CreateProvisionedModelThroughputInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateProvisionedModelThroughputInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateProvisionedModelThroughputOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateProvisionedModelThroughputInputDict
¶
Bases: TypedDict
Dictionary form of CreateProvisionedModelThroughputInput.
Attributes¶
client_request_token
instance-attribute
¶
client_request_token: str | None
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.
This field is autopopulated if not provided.
commitment_duration
instance-attribute
¶
commitment_duration: str | None
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
model_id
instance-attribute
¶
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.
model_units
instance-attribute
¶
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.
provisioned_model_name
instance-attribute
¶
The name for this Provisioned Throughput.
CreateProvisionedModelThroughputInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateProvisionedModelThroughputInput structure.
Attributes¶
client_request_token
class-attribute
instance-attribute
¶
client_request_token: str | None = ...
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.
This field is autopopulated if not provided.
commitment_duration
class-attribute
instance-attribute
¶
commitment_duration: str | None = ...
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
model_id
class-attribute
instance-attribute
¶
model_id: str | None = ...
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.
model_units
class-attribute
instance-attribute
¶
model_units: int | None = ...
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.
Output¶
CreateProvisionedModelThroughputOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateProvisionedModelThroughputOutput structure.
Attributes¶
provisioned_model_arn
instance-attribute
¶
provisioned_model_arn: str
The Amazon Resource Name (ARN) for this Provisioned Throughput.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.