ListAudienceGenerationJobs
Returns a list of audience generation jobs.
Request Syntax
GET /audience-generation-job?collaborationId=collaborationId&configuredAudienceModelArn=configuredAudienceModelArn&maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- collaborationId
-
The identifier of the collaboration that contains the audience generation jobs that you are interested in.
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} - configuredAudienceModelArn
-
The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs 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_/.]+ - maxResults
-
The maximum size of the results that is returned per call.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The token value retrieved from a previous call to access the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 10240.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"audienceGenerationJobs": [
{
"audienceGenerationJobArn": "string",
"collaborationId": "string",
"configuredAudienceModelArn": "string",
"createTime": "string",
"description": "string",
"name": "string",
"startedBy": "string",
"status": "string",
"updateTime": "string"
}
],
"nextToken": "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.
- audienceGenerationJobs
-
The audience generation jobs that match the request.
Type: Array of AudienceGenerationJobSummary objects
- nextToken
-
The token value used to access the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10240.
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
- 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:
