VoiceID / Paginator / ListFraudsters

ListFraudsters

class VoiceID.Paginator.ListFraudsters

paginator = client.get_paginator('list_fraudsters')

paginate(**kwargs)

Creates an iterator that will paginate through responses from VoiceID.Client.list_fraudsters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DomainId='string',
    WatchlistId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DomainId (string) –

  [REQUIRED]

  The identifier of the domain.

• WatchlistId (string) – The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.

• PaginationConfig (dict) –

  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.

Return type:

dict

Returns:

Response Syntax

{
    'FraudsterSummaries': [
        {
            'CreatedAt': datetime(2015, 1, 1),
            'DomainId': 'string',
            'GeneratedFraudsterId': 'string',
            'WatchlistIds': [
                '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) –