Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListTrainedModelVersions

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.

Request Syntax


GET /memberships/membershipIdentifier/trained-models/trainedModelArn/versions?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of trained model versions to return in a single page. The default value is 10, and the maximum value is 100.

Valid Range: Minimum value of 1. Maximum value of 100.

membershipIdentifier

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

nextToken

The pagination token from a previous ListTrainedModelVersions request. Use this token to retrieve the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 10240.

status

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.

trainedModelArn

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/trained-model/[-a-zA-Z0-9_/.]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "trainedModels": [ 
      { 
         "collaborationIdentifier": "string",
         "configuredModelAlgorithmAssociationArn": "string",
         "createTime": "string",
         "description": "string",
         "incrementalTrainingDataChannels": [ 
            { 
               "channelName": "string",
               "modelName": "string",
               "versionIdentifier": "string"
            }
         ],
         "membershipIdentifier": "string",
         "name": "string",
         "status": "string",
         "trainedModelArn": "string",
         "updateTime": "string",
         "versionIdentifier": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10240.

trainedModels

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.

Type: Array of TrainedModelSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ResourceNotFoundException

The resource you are requesting does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request parameters for this request are incorrect.

HTTP Status Code: 400