:doc:`VoiceID <../../voice-id>` / Client / describe_watchlist

******************
describe_watchlist
******************



.. py:method:: VoiceID.Client.describe_watchlist(**kwargs)

  

  Describes the specified watchlist.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeWatchlist>`_  


  **Request Syntax**
  ::

    response = client.describe_watchlist(
        DomainId='string',
        WatchlistId='string'
    )
    
  :type DomainId: string
  :param DomainId: **[REQUIRED]** 

    The identifier of the domain that contains the watchlist.

    

  
  :type WatchlistId: string
  :param WatchlistId: **[REQUIRED]** 

    The identifier of the watchlist that you are describing.

    

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

    
    ::

      {
          'Watchlist': {
              'CreatedAt': datetime(2015, 1, 1),
              'DefaultWatchlist': True|False,
              'Description': 'string',
              'DomainId': 'string',
              'Name': 'string',
              'UpdatedAt': datetime(2015, 1, 1),
              'WatchlistId': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Watchlist** *(dict) --* 

        Information about the specified watchlist.

        
        

        - **CreatedAt** *(datetime) --* 

          The timestamp of when the watchlist was created.

          
        

        - **DefaultWatchlist** *(boolean) --* 

          Whether the specified watchlist is the default watchlist of a domain.

          
        

        - **Description** *(string) --* 

          The description of the watchlist.

          
        

        - **DomainId** *(string) --* 

          The identifier of the domain that contains the watchlist.

          
        

        - **Name** *(string) --* 

          The name for the watchlist.

          
        

        - **UpdatedAt** *(datetime) --* 

          The timestamp of when the watchlist was updated.

          
        

        - **WatchlistId** *(string) --* 

          The identifier of the watchlist.

          
    
  
  **Exceptions**
  
  *   :py:class:`VoiceID.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`VoiceID.Client.exceptions.ValidationException`

  
  *   :py:class:`VoiceID.Client.exceptions.InternalServerException`

  
  *   :py:class:`VoiceID.Client.exceptions.ThrottlingException`

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

  