audience_export_jobs

Creates, updates, deletes, gets or lists an audience_export_jobs resource.

Overview

Name	audience_export_jobs
Type	Resource
Id	aws.cleanroomsml.audience_export_jobs

Fields

The following fields are returned by SELECT queries:

list_audience_export_jobs

Name	Datatype	Description
name	string	The name of the audience export job. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
audience_generation_job_arn	string	The Amazon Resource Name (ARN) of the audience generation job that was exported. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-generation-job/[-a-zA-Z0-9_/.]+</code>)
audience_size	object	The size of the generated audience. Must match one of the sizes in the configured audience model.
create_time	string (date-time)	The time at which the audience export job was created.
description	string	The description of the audience export job. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
output_location	string	The Amazon S3 bucket where the audience export is stored. (pattern: <code>s3:​//.+</code>)
status	string	The status of the audience export job. (CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE)
status_details	object	Details about the status of a resource.
update_time	string (date-time)	The most recent time at which the audience export job was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_audience_export_jobs	select	region	nextToken, maxResults, audienceGenerationJobArn	Returns a list of the audience export jobs.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
audienceGenerationJobArn	string	The Amazon Resource Name (ARN) of the audience generation job that you are interested in.
maxResults	integer	The maximum size of the results that is returned per call.
nextToken	string	The token value retrieved from a previous call to access the next page of results.

SELECT examples

list_audience_export_jobs

Returns a list of the audience export jobs.

SELECT
name,
audience_generation_job_arn,
audience_size,
create_time,
description,
output_location,
status,
status_details,
update_time
FROM aws.cleanroomsml.audience_export_jobs
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND audienceGenerationJobArn = '{{ audienceGenerationJobArn }}'
;