CleanRoomsML / Client / list_trained_model_versions

list_trained_model_versions

CleanRoomsML.Client.list_trained_model_versions(**kwargs)

Returns a list of trained model versions for a specified trained model. This operation allows you to view all versions of a trained model, including information about their status and creation details. You can use this to track the evolution of your trained models and select specific versions for inference or further training.

See also: AWS API Documentation

Request Syntax

response = client.list_trained_model_versions(
    nextToken='string',
    maxResults=123,
    membershipIdentifier='string',
    trainedModelArn='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'
)
Parameters:

  • nextToken (string) – The pagination token from a previous ListTrainedModelVersions request. Use this token to retrieve the next page of results.

  • maxResults (integer) – The maximum number of trained model versions to return in a single page. The default value is 10, and the maximum value is 100.

  • membershipIdentifier (string) –

    [REQUIRED]

    The membership identifier for the collaboration that contains the trained model.

  • trainedModelArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the trained model for which to list versions.

  • status (string) – Filter the results to only include trained model versions with the specified status. Valid values include CREATE_PENDING, CREATE_IN_PROGRESS, ACTIVE, CREATE_FAILED, and others.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'trainedModels': [
        {
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'trainedModelArn': 'string',
            'versionIdentifier': 'string',
            'incrementalTrainingDataChannels': [
                {
                    'channelName': 'string',
                    'versionIdentifier': 'string',
                    'modelName': '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 pagination token to use in a subsequent ListTrainedModelVersions request to retrieve the next page of results. This value is null when there are no more results to return.

    • trainedModels (list) –

      A list of trained model versions that match the specified criteria. Each entry contains summary information about a trained model version, including its version identifier, status, and creation details.

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

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

        • 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