Bedrock / Paginator / ListModelCopyJobs

ListModelCopyJobs

class Bedrock.Paginator.ListModelCopyJobs

paginator = client.get_paginator('list_model_copy_jobs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    creationTimeAfter=datetime(2015, 1, 1),
    creationTimeBefore=datetime(2015, 1, 1),
    statusEquals='InProgress'|'Completed'|'Failed',
    sourceAccountEquals='string',
    sourceModelArnEquals='string',
    targetModelNameContains='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• creationTimeAfter (datetime) – Filters for model copy jobs created after the specified time.

• creationTimeBefore (datetime) – Filters for model copy jobs created before the specified time.

• statusEquals (string) – Filters for model copy jobs whose status matches the value that you specify.

• sourceAccountEquals (string) – Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.

• sourceModelArnEquals (string) – Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.

• targetModelNameContains (string) – Filters for model copy jobs in which the name of the copied model contains the string that you specify.

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

• sortOrder (string) – Specifies whether to sort the results in ascending or descending order.

• 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

{
    'modelCopyJobSummaries': [
        {
            'jobArn': 'string',
            'status': 'InProgress'|'Completed'|'Failed',
            'creationTime': datetime(2015, 1, 1),
            'targetModelArn': 'string',
            'targetModelName': 'string',
            'sourceAccountId': 'string',
            'sourceModelArn': 'string',
            'targetModelKmsKeyArn': 'string',
            'targetModelTags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'failureMessage': 'string',
            'sourceModelName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • modelCopyJobSummaries (list) –

    A list of information about each model copy job.

    • (dict) –

      Contains details about each model copy job.

      This data type is used in the following API operations:

      • ListModelCopyJobs response

      • jobArn (string) –

        The Amazon Resoource Name (ARN) of the model copy job.

      • status (string) –

        The status of the model copy job.

      • creationTime (datetime) –

        The time that the model copy job was created.

      • targetModelArn (string) –

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

      • targetModelName (string) –

        The name of the copied model.

      • sourceAccountId (string) –

        The unique identifier of the account that the model being copied originated from.

      • sourceModelArn (string) –

        The Amazon Resource Name (ARN) of the original model being copied.

      • targetModelKmsKeyArn (string) –

        The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.

      • targetModelTags (list) –

        Tags associated with the copied model.

        • (dict) –

          Definition of the key/value pair for a tag.

          • key (string) –

            Key for the tag.

          • value (string) –

            Value for the tag.

      • failureMessage (string) –

        If a model fails to be copied, a message describing why the job failed is included here.

      • sourceModelName (string) –

        The name of the original model being copied.

  • NextToken (string) –

    A token to resume pagination.