VoiceID / Client / describe_watchlist

describe_watchlist#

VoiceID.Client.describe_watchlist(**kwargs)#

Describes the specified watchlist.

Request Syntax

response = client.describe_watchlist(
    DomainId='string',
    WatchlistId='string'
)

Parameters:

DomainId (string) –
[REQUIRED]

The identifier of the domain that contains the watchlist.
WatchlistId (string) –
[REQUIRED]

The identifier of the watchlist that you are describing.

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 specified 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

VoiceID.Client.exceptions.ResourceNotFoundException
VoiceID.Client.exceptions.ValidationException
VoiceID.Client.exceptions.InternalServerException
VoiceID.Client.exceptions.ThrottlingException
VoiceID.Client.exceptions.AccessDeniedException