CleanRoomsML / Client / list_audience_export_jobs

list_audience_export_jobs#

CleanRoomsML.Client.list_audience_export_jobs(**kwargs)#

Returns a list of the audience export jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_audience_export_jobs(
    audienceGenerationJobArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'audienceExportJobs': [
        {
            'audienceGenerationJobArn': 'string',
            'audienceSize': {
                'type': 'ABSOLUTE'|'PERCENTAGE',
                'value': 123
            },
            'createTime': datetime(2015, 1, 1),
            'description': 'string',
            'name': 'string',
            'outputLocation': 'string',
            'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE',
            'statusDetails': {
                'message': 'string',
                'statusCode': 'string'
            },
            'updateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • audienceExportJobs (list) –

      The audience export jobs that match the request.

      • (dict) –

        Provides information about the audience export job.

        • audienceGenerationJobArn (string) –

          The Amazon Resource Name (ARN) of the audience generation job that was exported.

        • audienceSize (dict) –

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

          • type (string) –

            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) –

            Specify an audience size value.

        • createTime (datetime) –

          The time at which the audience export job was created.

        • description (string) –

          The description of the audience export job.

        • name (string) –

          The name of the audience export job.

        • outputLocation (string) –

          The Amazon S3 bucket where the audience export is stored.

        • status (string) –

          The status of the audience export job.

        • statusDetails (dict) –

          Details about the status of a resource.

          • message (string) –

            The error message that was returned. The message is intended for human consumption and can change at any time. Use the statusCode for programmatic error handling.

          • statusCode (string) –

            The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.

        • updateTime (datetime) –

          The most recent time at which the audience export job was updated.

    • nextToken (string) –

      The token value retrieved from a previous call to access the next page of results.

Exceptions