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

GetTrainedModel

Returns information about a trained model.

Request Syntax

GET /memberships/membershipIdentifier/trained-models/trainedModelArn?versionIdentifier=versionIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

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

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 are interested in.

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",
   "dataChannels": [ 
      { 
         "channelName": "string",
         "mlInputChannelArn": "string",
         "s3DataDistributionType": "string"
      }
   ],
   "description": "string",
   "environment": { 
      "string" : "string" 
   },
   "hyperparameters": { 
      "string" : "string" 
   },
   "incrementalTrainingDataChannels": [ 
      { 
         "channelName": "string",
         "modelName": "string",
         "versionIdentifier": "string"
      }
   ],
   "kmsKeyArn": "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
   },
   "tags": { 
      "string" : "string" 
   },
   "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 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}/configured-model-algorithm-association/[-a-zA-Z0-9_/.]+

createTime

The time at which the trained model was created.

Type: Timestamp

dataChannels

The data channels that were used for the trained model.

Type: Array of ModelTrainingDataChannel objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

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]*

environment

The EC2 environment that was used to create the trained model.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 100 items.

Key Length Constraints: Minimum length of 1. Maximum length of 512.

Key Pattern: [a-zA-Z_][a-zA-Z0-9_]*

Value Length Constraints: Minimum length of 1. Maximum length of 512.

Value Pattern: [\S\s]*

hyperparameters

The hyperparameters that were used to create the trained model.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 100 items.

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Key Pattern: .*

Value Length Constraints: Minimum length of 1. Maximum length of 2500.

Value Pattern: .*

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.

kmsKeyArn

The Amazon Resource Name (ARN) of the AWS KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and associated data.

Type: String

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

Pattern: arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+

logsStatus

The logs status for the trained model.

Type: String

Valid Values: PUBLISH_SUCCEEDED | PUBLISH_FAILED

logsStatusDetails

Details about the logs status for the trained model.

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 metrics status for the trained model.

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 create the trained 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 was used to terminate model training.

Type: StoppingCondition object

tags

The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

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 image container.

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: