GetAudienceModel
Returns information about an audience model
Request Syntax
GET /audience-model/audienceModelArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- audienceModelArn
-
The Amazon Resource Name (ARN) of the audience 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}:audience-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
{
"audienceModelArn": "string",
"createTime": "string",
"description": "string",
"kmsKeyArn": "string",
"name": "string",
"status": "string",
"statusDetails": {
"message": "string",
"statusCode": "string"
},
"tags": {
"string" : "string"
},
"trainingDataEndTime": "string",
"trainingDatasetArn": "string",
"trainingDataStartTime": "string",
"updateTime": "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_/.]+ - createTime
-
The time at which the audience model was created.
Type: Timestamp
- 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]* - kmsKeyArn
-
The KMS key ARN used for the audience model.
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/.+ - name
-
The name of the audience model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]* - status
-
The status of the audience model.
Type: String
Valid Values:
CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_PENDING | DELETE_IN_PROGRESS | DELETE_FAILED - statusDetails
-
Details about the status of the audience model.
Type: StatusDetails object
-
The tags that are assigned to the audience model.
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.
- trainingDataEndTime
-
The end date specified for the training window.
Type: Timestamp
- trainingDatasetArn
-
The Amazon Resource Name (ARN) of the training dataset that was used 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_/.]+ - trainingDataStartTime
-
The start date specified for the training window.
Type: Timestamp
- updateTime
-
The most recent time at which the audience model was updated.
Type: Timestamp
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
- 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:
