CleanRoomsML / Client / list_collaboration_trained_models

list_collaboration_trained_models¶

CleanRoomsML.Client.list_collaboration_trained_models(**kwargs)¶

Returns a list of the trained models in a collaboration.

Request Syntax

response = client.list_collaboration_trained_models(
    nextToken='string',
    maxResults=123,
    collaborationIdentifier='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 models you are interested in.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'collaborationTrainedModels': [
        {
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'trainedModelArn': 'string',
            'name': 'string',
            'versionIdentifier': 'string',
            'incrementalTrainingDataChannels': [
                {
                    'channelName': 'string',
                    'versionIdentifier': 'string',
                    'modelName': 'string'
                },
            ],
            'description': 'string',
            'membershipIdentifier': 'string',
            'collaborationIdentifier': 'string',
            'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'INACTIVE'|'CANCEL_PENDING'|'CANCEL_IN_PROGRESS'|'CANCEL_FAILED',
            'configuredModelAlgorithmAssociationArn': 'string',
            'creatorAccountId': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The token value used to access the next page of results.
- collaborationTrainedModels (list) –
  
  The trained models in the collaboration that you requested.
  - (dict) –
    
    Provides summary information about a trained model in a collaboration.
    - createTime (datetime) –
      
      The time at which the trained model was created.
    - updateTime (datetime) –
      
      The most recent time at which the trained model was updated.
    - trainedModelArn (string) –
      
      The Amazon Resource Name (ARN) of the trained model.
    - name (string) –
      
      The name of the trained model.
    - versionIdentifier (string) –
      
      The version identifier of this trained model version.
    - incrementalTrainingDataChannels (list) –
      
      Information about the incremental training data channels used to create this version of the trained model.
      - (dict) –
        
        Contains information about an incremental training data channel that was used to create a trained model. This structure provides details about the base model and channel configuration used during incremental training.
        
        channelName (string) –
        
        The name of the incremental training data channel that was used.
        
        versionIdentifier (string) –
        
        The version identifier of the trained model that was used for incremental training.
        
        modelName (string) –
        
        The name of the base trained model that was used for incremental training.
    - description (string) –
      
      The description of the trained model.
    - membershipIdentifier (string) –
      
      The membership ID of the member that created the trained model.
    - collaborationIdentifier (string) –
      
      The collaboration ID of the collaboration that contains the trained model.
    - status (string) –
      
      The status of the trained model.
    - configuredModelAlgorithmAssociationArn (string) –
      
      The Amazon Resource Name (ARN) of the configured model algorithm association that is used for this trained model.
    - creatorAccountId (string) –
      
      The account ID of the member that created the trained model.

Exceptions

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