:doc:`CleanRoomsML <../../cleanroomsml>` / Paginator / ListAudienceExportJobs

**********************
ListAudienceExportJobs
**********************



.. py:class:: CleanRoomsML.Paginator.ListAudienceExportJobs

  ::

    
    paginator = client.get_paginator('list_audience_export_jobs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CleanRoomsML.Client.list_audience_export_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          audienceGenerationJobArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type audienceGenerationJobArn: string
    :param audienceGenerationJobArn: 

      The Amazon Resource Name (ARN) of the audience generation job that you are interested in.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

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

      

      - *(dict) --* 
        

        - **audienceExportJobs** *(list) --* 

          The audience export jobs that match the request.

          
          

          - *(dict) --* 

            Provides information about the audience export job.

            
            

            - **createTime** *(datetime) --* 

              The time at which the audience export job was created.

              
            

            - **updateTime** *(datetime) --* 

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

              
            

            - **name** *(string) --* 

              The name of 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.

                
          
            

            - **description** *(string) --* 

              The description of the audience export job.

              
            

            - **status** *(string) --* 

              The status of the audience export job.

              
            

            - **statusDetails** *(dict) --* 

              Details about the status of a resource.

              
              

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

                
              

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

                
          
            

            - **outputLocation** *(string) --* 

              The Amazon S3 bucket where the audience export is stored.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    