Bedrock / Client / list_provisioned_model_throughputs

list_provisioned_model_throughputs#

Bedrock.Client.list_provisioned_model_throughputs(**kwargs)#

List the provisioned capacities. For more information, see Provisioned throughput in the 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) – Return provisioned capacities created after the specified time.

  • creationTimeBefore (datetime) – Return provisioned capacities created before the specified time.

  • statusEquals (string) – Return the list of provisioned capacities that match the specified status.

  • modelArnEquals (string) – Return the list of provisioned capacities where their model ARN is equal to this parameter.

  • nameContains (string) – Return the list of provisioned capacities if their name contains these characters.

  • maxResults (integer) – THe maximum number of results to return in the response.

  • nextToken (string) – Continuation token from the previous response, for Bedrock to list the next set of results.

  • sortBy (string) – The field to sort by in the returned list of provisioned capacities.

  • 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) –

      Continuation token for the next request to list the next set of results.

    • provisionedModelSummaries (list) –

      List of summaries, one for each provisioned throughput in the response.

      • (dict) –

        Set of fields associated with a provisioned throughput.

        • provisionedModelName (string) –

          The name of the provisioned throughput.

        • provisionedModelArn (string) –

          The ARN of the provisioned throughput.

        • modelArn (string) –

          The ARN of the model associated with this provisioned throughput.

        • desiredModelArn (string) –

          Desired model ARN.

        • foundationModelArn (string) –

          Foundation model ARN.

        • modelUnits (integer) –

          The number of model units allocated.

        • desiredModelUnits (integer) –

          Desired model units.

        • status (string) –

          Status of the provisioned throughput.

        • commitmentDuration (string) –

          Commitment duration for the provisioned throughput.

        • commitmentExpirationTime (datetime) –

          Commitment expiration time for the provisioned throughput.

        • creationTime (datetime) –

          The time that this provisioned throughput was created.

        • lastModifiedTime (datetime) –

          The time that this provisioned throughput was last modified.

Exceptions

  • Bedrock.Client.exceptions.AccessDeniedException

  • Bedrock.Client.exceptions.ValidationException

  • Bedrock.Client.exceptions.InternalServerException

  • Bedrock.Client.exceptions.ThrottlingException