CleanRoomsML / Paginator / ListCollaborationTrainedModelExportJobs

ListCollaborationTrainedModelExportJobs

class CleanRoomsML.Paginator.ListCollaborationTrainedModelExportJobs

paginator = client.get_paginator('list_collaboration_trained_model_export_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CleanRoomsML.Client.list_collaboration_trained_model_export_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    collaborationIdentifier='string',
    trainedModelArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• collaborationIdentifier (string) –

  [REQUIRED]

  The collaboration ID of the collaboration that contains the trained model export jobs that you are interested in.

• trainedModelArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the trained model that was used to create the export jobs that you are interested in.

• 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

{
    'collaborationTrainedModelExportJobs': [
        {
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'name': 'string',
            'outputConfiguration': {
                'members': [
                    {
                        'accountId': 'string'
                    },
                ]
            },
            'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE',
            'statusDetails': {
                'statusCode': 'string',
                'message': 'string'
            },
            'description': 'string',
            'creatorAccountId': 'string',
            'trainedModelArn': 'string',
            'membershipIdentifier': 'string',
            'collaborationIdentifier': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • collaborationTrainedModelExportJobs (list) –

    The exports jobs that exist for the requested trained model in the requested collaboration.

    • (dict) –

      Provides summary information about a trained model export job in a collaboration.

      • createTime (datetime) –

        The time at which the trained model export job was created.

      • updateTime (datetime) –

        The most recent time at which the trained model export job was updated.

      • name (string) –

        The name of the trained model export job.

      • outputConfiguration (dict) –

        Information about the output of the trained model export job.

        • members (list) –

          The members that will received the exported trained model output.

          • (dict) –

            Provides information about the member who will receive trained model exports.

            • accountId (string) –

              The account ID of the member who will receive trained model exports.

      • status (string) –

        The status of the trained model.

      • statusDetails (dict) –

        Details about the status of a resource.

        • statusCode (string) –

          The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.

        • message (string) –

          The error message that was returned. The message is intended for human consumption and can change at any time. Use the statusCode for programmatic error handling.

      • description (string) –

        The description of the trained model.

      • creatorAccountId (string) –

        The account ID of the member that created the trained model.

      • trainedModelArn (string) –

        The Amazon Resource Name (ARN) of the trained model that is being exported.

      • membershipIdentifier (string) –

        The membership ID of the member that created the trained model export job.

      • collaborationIdentifier (string) –

        The collaboration ID of the collaboration that contains the trained model export job.

  • NextToken (string) –

    A token to resume pagination.