Bedrock / Paginator / ListCustomModels

ListCustomModels

class Bedrock.Paginator.ListCustomModels

paginator = client.get_paginator('list_custom_models')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    creationTimeBefore=datetime(2015, 1, 1),
    creationTimeAfter=datetime(2015, 1, 1),
    nameContains='string',
    baseModelArnEquals='string',
    foundationModelArnEquals='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending',
    isOwned=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• creationTimeBefore (datetime) – Return custom models created before the specified time.

• creationTimeAfter (datetime) – Return custom models created after the specified time.

• nameContains (string) – Return custom models only if the job name contains these characters.

• baseModelArnEquals (string) – Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

• foundationModelArnEquals (string) – Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

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

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

• isOwned (boolean) – Return custom models depending on if the current account owns them ( true) or if they were shared with the current account ( false).

• 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

{
    'modelSummaries': [
        {
            'modelArn': 'string',
            'modelName': 'string',
            'creationTime': datetime(2015, 1, 1),
            'baseModelArn': 'string',
            'baseModelName': 'string',
            'customizationType': 'FINE_TUNING'|'CONTINUED_PRE_TRAINING',
            'ownerAccountId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • modelSummaries (list) –

    Model summaries.

    • (dict) –

      Summary information for a custom model.

      • modelArn (string) –

        The Amazon Resource Name (ARN) of the custom model.

      • modelName (string) –

        The name of the custom model.

      • creationTime (datetime) –

        Creation time of the model.

      • baseModelArn (string) –

        The base model Amazon Resource Name (ARN).

      • baseModelName (string) –

        The base model name.

      • customizationType (string) –

        Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

      • ownerAccountId (string) –

        The unique identifier of the account that owns the model.

  • NextToken (string) –

    A token to resume pagination.