CleanRoomsML / Client / list_audience_generation_jobs

list_audience_generation_jobs#

CleanRoomsML.Client.list_audience_generation_jobs(**kwargs)#

Returns a list of audience generation jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_audience_generation_jobs(
    nextToken='string',
    maxResults=123,
    configuredAudienceModelArn='string',
    collaborationId='string'
)
Parameters:

  • nextToken (string) – The token value retrieved from a previous call to access the next page of results.

  • maxResults (integer) – The maximum size of the results that is returned per call.

  • configuredAudienceModelArn (string) – The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.

  • collaborationId (string) – The identifier of the collaboration that contains the audience generation jobs that you are interested in.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'audienceGenerationJobs': [
        {
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'audienceGenerationJobArn': 'string',
            'name': 'string',
            'description': 'string',
            'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
            'configuredAudienceModelArn': 'string',
            'collaborationId': 'string',
            'startedBy': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The token value used to access the next page of results.

    • audienceGenerationJobs (list) –

      The audience generation jobs that match the request.

      • (dict) –

        Provides information about the configured audience generation job.

        • createTime (datetime) –

          The time at which the audience generation job was created.

        • updateTime (datetime) –

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

        • audienceGenerationJobArn (string) –

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

        • name (string) –

          The name of the audience generation job.

        • description (string) –

          The description of the audience generation job.

        • status (string) –

          The status of the audience generation job.

        • configuredAudienceModelArn (string) –

          The Amazon Resource Name (ARN) of the configured audience model that was used for this audience generation job.

        • collaborationId (string) –

          The identifier of the collaboration that contains this audience generation job.

        • startedBy (string) –

          The AWS Account that submitted the job.

Exceptions

  • CleanRoomsML.Client.exceptions.ValidationException

  • CleanRoomsML.Client.exceptions.AccessDeniedException