Bedrock / Client / list_provisioned_model_throughputs

list_provisioned_model_throughputs#

Bedrock.Client.list_provisioned_model_throughputs(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_provisioned_model_throughputs(
    creationTimeAfter=datetime(2015, 1, 1),
    creationTimeBefore=datetime(2015, 1, 1),
    statusEquals='Creating'|'InService'|'Updating'|'Failed',
    modelArnEquals='string',
    nameContains='string',
    maxResults=123,
    nextToken='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending'
)
Parameters:

  • creationTimeAfter (datetime) – A filter that returns Provisioned Throughputs created after the specified time.

  • creationTimeBefore (datetime) – A filter that returns Provisioned Throughputs created before the specified time.

  • statusEquals (string) – A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.

  • 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.

  • 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.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'provisionedModelSummaries': [
        {
            'provisionedModelName': 'string',
            'provisionedModelArn': 'string',
            'modelArn': 'string',
            'desiredModelArn': 'string',
            'foundationModelArn': 'string',
            'modelUnits': 123,
            'desiredModelUnits': 123,
            'status': 'Creating'|'InService'|'Updating'|'Failed',
            'commitmentDuration': 'OneMonth'|'SixMonths',
            'commitmentExpirationTime': datetime(2015, 1, 1),
            'creationTime': datetime(2015, 1, 1),
            'lastModifiedTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      If there are more results than the number you specified in the maxResults field, this value is returned. To see the next batch of results, include this value in the nextToken field in another list request.

    • provisionedModelSummaries (list) –

      A list of summaries, one for each Provisioned Throughput in the response.

      • (dict) –

        A summary of information about a Provisioned Throughput.

        This data type is used in the following API operations:

        • provisionedModelName (string) –

          The name of the Provisioned Throughput.

        • provisionedModelArn (string) –

          The Amazon Resource Name (ARN) of the Provisioned Throughput.

        • modelArn (string) –

          The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.

        • desiredModelArn (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.

        • foundationModelArn (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.

        • modelUnits (integer) –

          The number of model units allocated to the Provisioned Throughput.

        • desiredModelUnits (integer) –

          The number of model units that was requested to be allocated to the Provisioned Throughput.

        • status (string) –

          The status of the Provisioned Throughput.

        • commitmentDuration (string) –

          The duration for which the Provisioned Throughput was committed.

        • commitmentExpirationTime (datetime) –

          The timestamp for when the commitment term of the Provisioned Throughput expires.

        • creationTime (datetime) –

          The time that the Provisioned Throughput was created.

        • lastModifiedTime (datetime) –

          The time that the Provisioned Throughput was last modified.

Exceptions