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

CreateAudienceModel

Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.

Request Syntax


POST /audience-model HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "kmsKeyArn": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   },
   "trainingDataEndTime": "string",
   "trainingDatasetArn": "string",
   "trainingDataStartTime": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

description

The description of the audience 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

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 audience model resource.

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

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

trainingDataEndTime

The end date and time of the training window.

Type: Timestamp

Required: No

trainingDatasetArn

The Amazon Resource Name (ARN) of the training dataset for this audience 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}:training-dataset/[-a-zA-Z0-9_/.]+

Required: Yes

trainingDataStartTime

The start date and time of the training window.

Type: Timestamp

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

audienceModelArn

The Amazon Resource Name (ARN) of the audience 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}:audience-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