VoiceID / Client / list_watchlists

list_watchlists#

VoiceID.Client.list_watchlists(**kwargs)#

Lists all watchlists in a specified domain.

See also: AWS API Documentation

Request Syntax

response = client.list_watchlists(
    DomainId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • DomainId (string) –

    [REQUIRED]

    The identifier of the domain.

  • MaxResults (integer) – 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.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    '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) –

    • 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.

    • 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.

Exceptions

  • VoiceID.Client.exceptions.ResourceNotFoundException

  • VoiceID.Client.exceptions.ValidationException

  • VoiceID.Client.exceptions.InternalServerException

  • VoiceID.Client.exceptions.ThrottlingException

  • VoiceID.Client.exceptions.AccessDeniedException