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

***************
list_fraudsters
***************



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

  

  Lists all fraudsters in a specified watchlist or domain.

  

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


  **Request Syntax**
  ::

    response = client.list_fraudsters(
        DomainId='string',
        MaxResults=123,
        NextToken='string',
        WatchlistId='string'
    )
    
  :type DomainId: string
  :param DomainId: **[REQUIRED]** 

    The identifier of the domain.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results that are returned per call. You can use ``NextToken`` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

    

  
  :type NextToken: string
  :param NextToken: 

    If ``NextToken`` is returned, there are more results available. The value of ``NextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

    

  
  :type WatchlistId: string
  :param WatchlistId: 

    The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.

    

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

    
    ::

      {
          'FraudsterSummaries': [
              {
                  'CreatedAt': datetime(2015, 1, 1),
                  'DomainId': 'string',
                  'GeneratedFraudsterId': 'string',
                  'WatchlistIds': [
                      'string',
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **FraudsterSummaries** *(list) --* 

        A list that contains details about each fraudster in the Amazon Web Services account.

        
        

        - *(dict) --* 

          Contains a summary of information about a fraudster.

          
          

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

            The timestamp of when the fraudster summary was created.

            
          

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

            The identifier of the domain that contains the fraudster summary.

            
          

          - **GeneratedFraudsterId** *(string) --* 

            The service-generated identifier for the fraudster.

            
          

          - **WatchlistIds** *(list) --* 

            The identifier of the watchlists the fraudster is a part of.

            
            

            - *(string) --* 
        
      
    
      

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

        If ``NextToken`` is returned, there are more results available. The value of ``NextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

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

  