provisioned_model_throughputs

Creates, updates, deletes, gets or lists a provisioned_model_throughputs resource.

Overview

Name	provisioned_model_throughputs
Type	Resource
Id	aws.bedrock.provisioned_model_throughputs

Fields

The following fields are returned by SELECT queries:

get_provisioned_model_throughput

Name	Datatype	Description
commitment_duration	string	Commitment duration of the Provisioned Throughput. (OneMonth, SixMonths)
commitment_expiration_time	string (date-time)	The timestamp for when the commitment term for the Provisioned Throughput expires.
creation_time	string (date-time)	The timestamp of the creation time for this Provisioned Throughput.
desired_model_arn	string	The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))</code>)
desired_model_units	integer	The number of model units that was requested for this Provisioned Throughput.
failure_message	string	A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput.
foundation_model_arn	string	The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}</code>)
last_modified_time	string (date-time)	The timestamp of the last time that this Provisioned Throughput was modified.
model_arn	string	The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))</code>)
model_units	integer	The number of model units allocated to this Provisioned Throughput.
provisioned_model_arn	string	The Amazon Resource Name (ARN) of the Provisioned Throughput. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}</code>)
provisioned_model_name	string	The name of the Provisioned Throughput. (pattern: <code>([0-9a-zA-Z][_-]?)+</code>)
status	string	The status of the Provisioned Throughput. (Creating, InService, Updating, Failed)

list_provisioned_model_throughputs

Name	Datatype	Description
commitment_duration	string	The duration for which the Provisioned Throughput was committed. (OneMonth, SixMonths)
commitment_expiration_time	string (date-time)	The timestamp for when the commitment term of the Provisioned Throughput expires.
creation_time	string (date-time)	The time that the Provisioned Throughput was created.
desired_model_arn	string	The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))</code>)
desired_model_units	integer	The number of model units that was requested to be allocated to the Provisioned Throughput.
foundation_model_arn	string	The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}</code>)
last_modified_time	string (date-time)	The time that the Provisioned Throughput was last modified.
model_arn	string	The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))</code>)
model_units	integer	The number of model units allocated to the Provisioned Throughput.
provisioned_model_arn	string	The Amazon Resource Name (ARN) of the Provisioned Throughput. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}</code>)
provisioned_model_name	string	The name of the Provisioned Throughput. (pattern: <code>([0-9a-zA-Z][_-]?)+</code>)
status	string	The status of the Provisioned Throughput. (Creating, InService, Updating, Failed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_provisioned_model_throughput	select	provisioned_model_id, region		Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
list_provisioned_model_throughputs	select	region	creationTimeAfter, creationTimeBefore, statusEquals, modelArnEquals, nameContains, maxResults, nextToken, sortBy, sortOrder	Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
create_provisioned_model_throughput	insert	region, modelUnits, provisionedModelName, modelId		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.
update_provisioned_model_throughput	update	provisioned_model_id, region		Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
delete_provisioned_model_throughput	delete	provisioned_model_id, region		Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
provisioned_model_id	string	The Amazon Resource Name (ARN) or name of the Provisioned Throughput.
region	string	AWS region (default: us-east-1)
creationTimeAfter	string (date-time)	A filter that returns Provisioned Throughputs created after the specified time.
creationTimeBefore	string (date-time)	A filter that returns Provisioned Throughputs created before the specified time.
maxResults	integer	THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a nextToken value. To see the next batch of results, send the nextToken value in another list request.
modelArnEquals	string	A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.
nameContains	string	A filter that returns Provisioned Throughputs if their name contains the expression that you specify.
nextToken	string	If there are more results than the number you specified in the maxResults field, the response returns a nextToken value. To see the next batch of results, specify the nextToken value in this field.
sortBy	string	The field by which to sort the returned list of Provisioned Throughputs.
sortOrder	string	The sort order of the results.
statusEquals	string	A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.

SELECT examples

get_provisioned_model_throughput

Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

SELECT
commitment_duration,
commitment_expiration_time,
creation_time,
desired_model_arn,
desired_model_units,
failure_message,
foundation_model_arn,
last_modified_time,
model_arn,
model_units,
provisioned_model_arn,
provisioned_model_name,
status
FROM aws.bedrock.provisioned_model_throughputs
WHERE provisioned_model_id = '{{ provisioned_model_id }}' -- required
AND region = '{{ region }}' -- required
;

list_provisioned_model_throughputs

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

SELECT
commitment_duration,
commitment_expiration_time,
creation_time,
desired_model_arn,
desired_model_units,
foundation_model_arn,
last_modified_time,
model_arn,
model_units,
provisioned_model_arn,
provisioned_model_name,
status
FROM aws.bedrock.provisioned_model_throughputs
WHERE region = '{{ region }}' -- required
AND creationTimeAfter = '{{ creationTimeAfter }}'
AND creationTimeBefore = '{{ creationTimeBefore }}'
AND statusEquals = '{{ statusEquals }}'
AND modelArnEquals = '{{ modelArnEquals }}'
AND nameContains = '{{ nameContains }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;

INSERT examples

create_provisioned_model_throughput

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.

INSERT INTO aws.bedrock.provisioned_model_throughputs (
clientRequestToken,
modelUnits,
provisionedModelName,
modelId,
commitmentDuration,
tags,
region
)
SELECT 
'{{ clientRequestToken }}',
{{ modelUnits }} /* required */,
'{{ provisionedModelName }}' /* required */,
'{{ modelId }}' /* required */,
'{{ commitmentDuration }}',
'{{ tags }}',
'{{ region }}'
RETURNING
provisioned_model_arn
;

Manifest

# Description fields are for documentation purposes
- name: provisioned_model_throughputs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the provisioned_model_throughputs resource.
  - name: clientRequestToken
    value: "{{ clientRequestToken }}"
  - name: modelUnits
    value: {{ modelUnits }}
  - name: provisionedModelName
    value: "{{ provisionedModelName }}"
  - name: modelId
    value: "{{ modelId }}"
  - name: commitmentDuration
    value: "{{ commitmentDuration }}"
    valid_values: ['OneMonth', 'SixMonths']
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_provisioned_model_throughput

Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

UPDATE aws.bedrock.provisioned_model_throughputs
SET 
desiredProvisionedModelName = '{{ desiredProvisionedModelName }}',
desiredModelId = '{{ desiredModelId }}'
WHERE 
provisioned_model_id = '{{ provisioned_model_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_provisioned_model_throughput

Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

DELETE FROM aws.bedrock.provisioned_model_throughputs
WHERE provisioned_model_id = '{{ provisioned_model_id }}' --required
AND region = '{{ region }}' --required
;