GetCollaborationTrainedModel - AWS Clean Rooms ML
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetCollaborationTrainedModel

Returns information about a trained model in a collaboration.

Request Syntax

GET /collaborations/collaborationIdentifier/trained-models/trainedModelArn?versionIdentifier=versionIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

collaborationIdentifier

The collaboration ID that contains the trained model that you want to return information about.

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

trainedModelArn

The Amazon Resource Name (ARN) of the trained model that you want to return information about.

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

versionIdentifier

The version identifier of the trained model to retrieve. If not specified, the operation returns information about the latest version of 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}

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "collaborationIdentifier": "string",
   "configuredModelAlgorithmAssociationArn": "string",
   "createTime": "string",
   "creatorAccountId": "string",
   "description": "string",
   "incrementalTrainingDataChannels": [ 
      { 
         "channelName": "string",
         "modelName": "string",
         "versionIdentifier": "string"
      }
   ],
   "logsStatus": "string",
   "logsStatusDetails": "string",
   "membershipIdentifier": "string",
   "metricsStatus": "string",
   "metricsStatusDetails": "string",
   "name": "string",
   "resourceConfig": { 
      "instanceCount": number,
      "instanceType": "string",
      "volumeSizeInGB": number
   },
   "status": "string",
   "statusDetails": { 
      "message": "string",
      "statusCode": "string"
   },
   "stoppingCondition": { 
      "maxRuntimeInSeconds": number
   },
   "trainedModelArn": "string",
   "trainingContainerImageDigest": "string",
   "trainingInputMode": "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.

collaborationIdentifier

The collaboration ID of the collaboration that contains the trained model.

Type: String

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}

configuredModelAlgorithmAssociationArn

The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.

Type: String

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}/configured-model-algorithm-association/[-a-zA-Z0-9_/.]+

createTime

The time at which the trained model was created.

Type: Timestamp

creatorAccountId

The account ID of the member that created the trained model.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

description

The description of the trained model.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

incrementalTrainingDataChannels

Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.

Type: Array of IncrementalTrainingDataChannelOutput objects

Array Members: Fixed number of 1 item.

logsStatus

Status information for the logs.

Type: String

Valid Values: PUBLISH_SUCCEEDED | PUBLISH_FAILED

logsStatusDetails

Details about the status information for the logs.

Type: String

membershipIdentifier

The membership ID of the member that created the trained model.

Type: String

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}

metricsStatus

The status of the model metrics.

Type: String

Valid Values: PUBLISH_SUCCEEDED | PUBLISH_FAILED

metricsStatusDetails

Details about the status information for the model metrics.

Type: String

name

The name of the trained model.

Type: String

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

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

resourceConfig

The EC2 resource configuration that was used to train this model.

Type: ResourceConfig object

status

The status of the trained model.

Type: String

Valid Values: CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_PENDING | DELETE_IN_PROGRESS | DELETE_FAILED | INACTIVE | CANCEL_PENDING | CANCEL_IN_PROGRESS | CANCEL_FAILED

statusDetails

Details about the status of a resource.

Type: StatusDetails object

stoppingCondition

The stopping condition that determined when model training ended.

Type: StoppingCondition object

trainedModelArn

The Amazon Resource Name (ARN) of the trained model.

Type: String

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_/.]+

trainingContainerImageDigest

Information about the training container image.

Type: String

trainingInputMode

The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.

Type: String

Valid Values: File | FastFile | Pipe

updateTime

The most recent time at which the trained model was updated.

Type: Timestamp

versionIdentifier

The version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same trained model.

Type: String

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}

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: