CleanRoomsML / Client / start_audience_export_job

start_audience_export_job#

CleanRoomsML.Client.start_audience_export_job(**kwargs)#

Export an audience of a specified size after you have generated an audience.

See also: AWS API Documentation

Request Syntax

response = client.start_audience_export_job(
    name='string',
    audienceGenerationJobArn='string',
    audienceSize={
        'type': 'ABSOLUTE'|'PERCENTAGE',
        'value': 123
    },
    description='string'
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the audience export job.

  • audienceGenerationJobArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the audience generation job that you want to export.

  • audienceSize (dict) –

    [REQUIRED]

    The size of the generated audience. Must match one of the sizes in the configured audience model.

    • type (string) – [REQUIRED]

      Whether the audience size is defined in absolute terms or as a percentage. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

    • value (integer) – [REQUIRED]

      Specify an audience size value.

  • description (string) – The description of the audience export job.

Returns:

None

Exceptions