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

CreateTrainedModel

Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.

Request Syntax

POST /memberships/membershipIdentifier/trained-models HTTP/1.1
Content-type: application/json

{
   "configuredModelAlgorithmAssociationArn": "string",
   "dataChannels": [ 
      { 
         "channelName": "string",
         "mlInputChannelArn": "string"
      }
   ],
   "description": "string",
   "environment": { 
      "string" : "string" 
   },
   "hyperparameters": { 
      "string" : "string" 
   },
   "kmsKeyArn": "string",
   "name": "string",
   "resourceConfig": { 
      "instanceCount": number,
      "instanceType": "string",
      "volumeSizeInGB": number
   },
   "stoppingCondition": { 
      "maxRuntimeInSeconds": number
   },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

The membership ID of the member that is creating 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

Request Body

The request accepts the following data in JSON format.

configuredModelAlgorithmAssociationArn

The associated configured model algorithm used to train this 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_/.]+

Required: Yes

dataChannels

Defines the data channels that are used as input for the trained model request.

Type: Array of ModelTrainingDataChannel objects

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

Required: Yes

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

Required: No

environment

The environment variables to set in the Docker container.

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

Required: No

hyperparameters

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process.

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: .*

Required: No

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 the 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/.+

Required: No

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

Required: Yes

resourceConfig

Information about the EC2 resources that are used to train this model.

Type: ResourceConfig object

Required: Yes

stoppingCondition

The criteria that is used to stop model training.

Type: StoppingCondition object

Required: No

tags

The optional metadata that you apply 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.

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "trainedModelArn": "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.

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

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

ConflictException

You can't complete this action because another resource depends on this resource.

HTTP Status Code: 409

ResourceNotFoundException

The resource you are requesting does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

You have exceeded your service quota.

HTTP Status Code: 402

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: