GetConfiguredAudienceModel
Returns information about a specified configured audience model.
Request Syntax
GET /configured-audience-model/configuredAudienceModelArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- configuredAudienceModelArn
-
The Amazon Resource Name (ARN) of the configured 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}:configured-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",
"audienceSizeConfig": {
"audienceSizeBins": [ number ],
"audienceSizeType": "string"
},
"childResourceTagOnCreatePolicy": "string",
"configuredAudienceModelArn": "string",
"createTime": "string",
"description": "string",
"minMatchingSeedSize": number,
"name": "string",
"outputConfig": {
"destination": {
"s3Destination": {
"s3Uri": "string"
}
},
"roleArn": "string"
},
"sharedAudienceMetrics": [ "string" ],
"status": "string",
"tags": {
"string" : "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 used for this configured 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_/.]+ - audienceSizeConfig
-
The list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an
audienceSizeselected from this list. You can use theABSOLUTEAudienceSize to configure out audience sizes using the count of identifiers in the output. You can use thePercentageAudienceSize to configure sizes in the range 1-100 percent.Type: AudienceSizeConfig object
- childResourceTagOnCreatePolicy
-
Provides the
childResourceTagOnCreatePolicythat was used for this configured audience model.Type: String
Valid Values:
FROM_PARENT_RESOURCE | NONE - configuredAudienceModelArn
-
The Amazon Resource Name (ARN) of the configured 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}:configured-audience-model/[-a-zA-Z0-9_/.]+ - createTime
-
The time at which the configured audience model was created.
Type: Timestamp
- description
-
The description of the configured 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]* - minMatchingSeedSize
-
The minimum number of users from the seed audience that must match with users in the training data of the audience model.
Type: Integer
Valid Range: Minimum value of 25. Maximum value of 500000.
- name
-
The name of the configured 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]* - outputConfig
-
The output configuration of the configured audience model
Type: ConfiguredAudienceModelOutputConfig object
-
Whether audience metrics are shared.
Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values:
ALL | NONE - status
-
The status of the configured audience model.
Type: String
Valid Values:
ACTIVE -
The tags that are associated to this configured 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.
- updateTime
-
The most recent time at which the configured 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:
