VoiceID / Paginator / ListWatchlists

ListWatchlists

class VoiceID.Paginator.ListWatchlists

paginator = client.get_paginator('list_watchlists')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DomainId (string) –

  [REQUIRED]

  The identifier of the domain.

• 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

{
    'WatchlistSummaries': [
        {
            'CreatedAt': datetime(2015, 1, 1),
            'DefaultWatchlist': True|False,
            'Description': 'string',
            'DomainId': 'string',
            'Name': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'WatchlistId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • WatchlistSummaries (list) –

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

    • (dict) –

      Contains a summary of information about a 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 last updated.

      • WatchlistId (string) –

        The identifier of the watchlist.