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

****************
create_watchlist
****************



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

  

  Creates a watchlist that fraudsters can be a part of.

  

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


  **Request Syntax**
  ::

    response = client.create_watchlist(
        ClientToken='string',
        Description='string',
        DomainId='string',
        Name='string'
    )
    
  :type ClientToken: string
  :param ClientToken: 

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see `Making retries safe with idempotent APIs <https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/>`__.

    This field is autopopulated if not provided.

  
  :type Description: string
  :param Description: 

    A brief description of this watchlist.

    

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

    The identifier of the domain that contains the watchlist.

    

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

    The name of the watchlist.

    

  
  
  :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 newly created 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.ServiceQuotaExceededException`

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

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

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

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

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

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

  