VoiceID / Client / update_watchlist

update_watchlist#

VoiceID.Client.update_watchlist(**kwargs)#

Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.

See also: AWS API Documentation

Request Syntax

response = client.update_watchlist(
    Description='string',
    DomainId='string',
    Name='string',
    WatchlistId='string'
)
Parameters:

  • Description (string) – A brief description about this watchlist.

  • DomainId (string) –

    [REQUIRED]

    The identifier of the domain that contains the watchlist.

  • Name (string) – The name of the watchlist.

  • WatchlistId (string) –

    [REQUIRED]

    The identifier of the watchlist to be updated.

Return type:

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) –

      Details about the updated 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