CleanRoomsML / Client / list_trained_models

list_trained_models#

CleanRoomsML.Client.list_trained_models(**kwargs)#

Returns a list of trained models.

See also: AWS API Documentation

Request Syntax

response = client.list_trained_models(
    nextToken='string',
    maxResults=123,
    membershipIdentifier='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.

  • membershipIdentifier (string) –

    [REQUIRED]

    The membership ID of the member that created the trained models you are interested in.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'trainedModels': [
        {
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'trainedModelArn': 'string',
            'name': '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'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

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

    • trainedModels (list) –

      The list of trained models.

      • (dict) –

        Summary information about the trained model.

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

        • 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 was used to create this trained model.

Exceptions

  • CleanRoomsML.Client.exceptions.ValidationException

  • CleanRoomsML.Client.exceptions.AccessDeniedException