CleanRoomsML / Client / list_collaboration_trained_model_export_jobs

list_collaboration_trained_model_export_jobs#

CleanRoomsML.Client.list_collaboration_trained_model_export_jobs(**kwargs)#

Returns a list of the export jobs for a trained model in a collaboration.

See also: AWS API Documentation

Request Syntax

response = client.list_collaboration_trained_model_export_jobs(
    nextToken='string',
    maxResults=123,
    collaborationIdentifier='string',
    trainedModelArn='string'
)
Parameters:
  • nextToken (string) – The token value retrieved from a previous call to access the next page of results.

  • maxResults (integer) – The maximum size of the results that is returned per call.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      The token value used to access the next page of results.

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

Exceptions

  • CleanRoomsML.Client.exceptions.ValidationException

  • CleanRoomsML.Client.exceptions.AccessDeniedException