CleanRoomsML / Client / list_collaboration_trained_model_inference_jobs

list_collaboration_trained_model_inference_jobs#

CleanRoomsML.Client.list_collaboration_trained_model_inference_jobs(**kwargs)#

Returns a list of trained model inference jobs in a specified collaboration.

Request Syntax

response = client.list_collaboration_trained_model_inference_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 inference jobs that you are interested in.
trainedModelArn (string) – The Amazon Resource Name (ARN) of the trained model that was used to create the trained model inference jobs that you are interested in.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'collaborationTrainedModelInferenceJobs': [
        {
            'trainedModelInferenceJobArn': 'string',
            'configuredModelAlgorithmAssociationArn': 'string',
            'membershipIdentifier': 'string',
            'trainedModelArn': 'string',
            'collaborationIdentifier': 'string',
            'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'CANCEL_PENDING'|'CANCEL_IN_PROGRESS'|'CANCEL_FAILED'|'INACTIVE',
            'outputConfiguration': {
                'accept': 'string',
                'members': [
                    {
                        'accountId': 'string'
                    },
                ]
            },
            'name': 'string',
            'description': 'string',
            'metricsStatus': 'PUBLISH_SUCCEEDED'|'PUBLISH_FAILED',
            'metricsStatusDetails': 'string',
            'logsStatus': 'PUBLISH_SUCCEEDED'|'PUBLISH_FAILED',
            'logsStatusDetails': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'creatorAccountId': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The token value used to access the next page of results.
- collaborationTrainedModelInferenceJobs (list) –
  
  The trained model inference jobs that you are interested in.
  - (dict) –
    
    Provides summary information about a trained model inference job in a collaboration.
    - trainedModelInferenceJobArn (string) –
      
      The Amazon Resource Name (ARN) of the trained model inference job.
    - configuredModelAlgorithmAssociationArn (string) –
      
      The Amazon Resource Name (ARN) of the configured model algorithm association that is used for the trained model inference job.
    - membershipIdentifier (string) –
      
      The membership ID of the membership that contains the trained model inference job.
    - trainedModelArn (string) –
      
      The Amazon Resource Name (ARN) of the trained model that is used for the trained model inference job.
    - collaborationIdentifier (string) –
      
      The collaboration ID of the collaboration that contains the trained model inference job.
    - status (string) –
      
      The status of the trained model inference job.
    - outputConfiguration (dict) –
      
      Returns output configuration information for the trained model inference job.
      - accept (string) –
        
        The MIME type used to specify the output data.
      - members (list) –
        
        Defines the members that can receive inference output.
        
        (dict) –
        
        Defines who will receive inference results.
        
        accountId (string) –
        
        The account ID of the member that can receive inference results.
    - name (string) –
      
      The name of the trained model inference job.
    - description (string) –
      
      The description of the trained model inference job.
    - metricsStatus (string) –
      
      the trained model inference job metrics status.
    - metricsStatusDetails (string) –
      
      Details about the metrics status for trained model inference job.
    - logsStatus (string) –
      
      The trained model inference job logs status.
    - logsStatusDetails (string) –
      
      Details about the logs status for the trained model inference job.
    - createTime (datetime) –
      
      The time at which the trained model inference job was created.
    - updateTime (datetime) –
      
      The most recent time at which the trained model inference job was updated.
    - creatorAccountId (string) –
      
      The account ID that created the trained model inference job.

Exceptions

CleanRoomsML.Client.exceptions.ValidationException
CleanRoomsML.Client.exceptions.AccessDeniedException