Bedrock / Paginator / ListProvisionedModelThroughputs

ListProvisionedModelThroughputs

class Bedrock.Paginator.ListProvisionedModelThroughputs

paginator = client.get_paginator('list_provisioned_model_throughputs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Bedrock.Client.list_provisioned_model_throughputs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    creationTimeAfter=datetime(2015, 1, 1),
    creationTimeBefore=datetime(2015, 1, 1),
    statusEquals='Creating'|'InService'|'Updating'|'Failed',
    modelArnEquals='string',
    nameContains='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• sortBy (string) – The field by which to sort the returned list of Provisioned Throughputs.

• sortOrder (string) – The sort order of the results.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

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

      • ListProvisionedThroughputs response

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

  • NextToken (string) –

    A token to resume pagination.