:doc:`CleanRoomsML <../../cleanroomsml>` / Client / list_audience_models

********************
list_audience_models
********************



.. py:method:: CleanRoomsML.Client.list_audience_models(**kwargs)

  

  Returns a list of audience models.

  

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


  **Request Syntax**
  ::

    response = client.list_audience_models(
        nextToken='string',
        maxResults=123
    )
    
  :type nextToken: string
  :param nextToken: 

    The token value retrieved from a previous call to access the next page of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum size of the results that is returned per call.

    

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

    
    ::

      {
          'nextToken': 'string',
          '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'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

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

        
      

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`CleanRoomsML.Client.exceptions.ValidationException`

  
  *   :py:class:`CleanRoomsML.Client.exceptions.AccessDeniedException`

  