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

******************
ListAudienceModels
******************



.. py:class:: CleanRoomsML.Paginator.ListAudienceModels

  ::

    
    paginator = client.get_paginator('list_audience_models')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'audienceModels': [
                {
                    'createTime': datetime(2015, 1, 1),
                    'updateTime': datetime(2015, 1, 1),
                    'audienceModelArn': 'string',
                    'name': 'string',
                    'trainingDatasetArn': 'string',
                    'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
                    'description': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **audienceModels** *(list) --* 

          The audience models that match the request.

          
          

          - *(dict) --* 

            Information about the audience model.

            
            

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

              The time at which the audience model was created.

              
            

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

              The most recent time at which the audience model was updated.

              
            

            - **audienceModelArn** *(string) --* 

              The Amazon Resource Name (ARN) of the audience model.

              
            

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

              The name of the audience model.

              
            

            - **trainingDatasetArn** *(string) --* 

              The Amazon Resource Name (ARN) of the training dataset that was used for the audience model.

              
            

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

              The status of the audience model.

              
            

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

              The description of the audience model.

              
        
      
        

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

          A token to resume pagination.

          
    