VoiceID / Client / create_watchlist

create_watchlist#

VoiceID.Client.create_watchlist(**kwargs)#

Creates a watchlist that fraudsters can be a part of.

See also: AWS API Documentation

Request Syntax

response = client.create_watchlist(
    ClientToken='string',
    Description='string',
    DomainId='string',
    Name='string'
)
Parameters:

  • ClientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    This field is autopopulated if not provided.

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

  • DomainId (string) –

    [REQUIRED]

    The identifier of the domain that contains the watchlist.

  • Name (string) –

    [REQUIRED]

    The name of the watchlist.

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

      Information about the newly created 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