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

****************************
ListConfiguredAudienceModels
****************************



.. py:class:: CleanRoomsML.Paginator.ListConfiguredAudienceModels

  ::

    
    paginator = client.get_paginator('list_configured_audience_models')

  
  

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

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

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


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

      
      ::

        {
            'configuredAudienceModels': [
                {
                    'createTime': datetime(2015, 1, 1),
                    'updateTime': datetime(2015, 1, 1),
                    'name': 'string',
                    'audienceModelArn': 'string',
                    'outputConfig': {
                        'destination': {
                            's3Destination': {
                                's3Uri': 'string'
                            }
                        },
                        'roleArn': 'string'
                    },
                    'description': 'string',
                    'configuredAudienceModelArn': 'string',
                    'status': 'ACTIVE'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **configuredAudienceModels** *(list) --* 

          The configured audience models.

          
          

          - *(dict) --* 

            Information about the configured audience model.

            
            

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

              The time at which the configured audience model was created.

              
            

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

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

              
            

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

              The name of the configured audience model.

              
            

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

              The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model.

              
            

            - **outputConfig** *(dict) --* 

              The output configuration of the configured audience model.

              
              

              - **destination** *(dict) --* 

                Defines the Amazon S3 bucket where the configured audience is stored.

                
                

                - **s3Destination** *(dict) --* 

                  The Amazon S3 bucket and path for the configured audience.

                  
                  

                  - **s3Uri** *(string) --* 

                    The Amazon S3 location URI.

                    
              
            
              

              - **roleArn** *(string) --* 

                The ARN of the IAM role that can write the Amazon S3 bucket.

                
          
            

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

              The description of the configured audience model.

              
            

            - **configuredAudienceModelArn** *(string) --* 

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

              
            

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

              The status of the configured audience model.

              
        
      
        

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

          A token to resume pagination.

          
    