CleanRoomsML / Paginator / ListAudienceGenerationJobs
ListAudienceGenerationJobs#
- class CleanRoomsML.Paginator.ListAudienceGenerationJobs#
paginator = client.get_paginator('list_audience_generation_jobs')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
CleanRoomsML.Client.list_audience_generation_jobs()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( collaborationId='string', configuredAudienceModelArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
collaborationId (string) – The identifier of the collaboration that contains the audience generation jobs that you are interested in.
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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'audienceGenerationJobs': [ { 'audienceGenerationJobArn': 'string', 'collaborationId': 'string', 'configuredAudienceModelArn': 'string', 'createTime': datetime(2015, 1, 1), 'description': 'string', 'name': 'string', 'startedBy': 'string', 'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_FAILED', 'updateTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
audienceGenerationJobs (list) –
The audience generation jobs that match the request.
(dict) –
Provides information about the configured audience generation job.
audienceGenerationJobArn (string) –
The Amazon Resource Name (ARN) of the audience generation job.
collaborationId (string) –
The identifier of the collaboration that contains this audience generation job.
configuredAudienceModelArn (string) –
The Amazon Resource Name (ARN) of the configured audience model that was used for this audience generation job.
createTime (datetime) –
The time at which the audience generation job was created.
description (string) –
The description of the audience generation job.
name (string) –
The name of the audience generation job.
startedBy (string) –
The AWS Account that submitted the job.
status (string) –
The status of the audience generation job.
updateTime (datetime) –
The most recent time at which the audience generation job was updated.
NextToken (string) –
A token to resume pagination.