StartAudienceExportJob
Export an audience of a specified size after you have generated an audience.
Request Syntax
POST /audience-export-job HTTP/1.1
Content-type: application/json
{
"audienceGenerationJobArn": "string",
"audienceSize": {
"type": "string",
"value": number
},
"description": "string",
"name": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- audienceGenerationJobArn
-
The Amazon Resource Name (ARN) of the audience generation job that you want to export.
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-generation-job/[-a-zA-Z0-9_/.]+Required: Yes
- audienceSize
-
The size of the generated audience. Must match one of the sizes in the configured audience model.
Type: AudienceSize object
Required: Yes
- description
-
The description of the audience export job.
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
- name
-
The name of the audience export job.
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
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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:
