watchlists

Creates, updates, deletes, gets or lists a watchlists resource.

Overview

Name	watchlists
Type	Resource
Id	aws.voice_id.watchlists

Fields

The following fields are returned by SELECT queries:

describe_watchlist

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the watchlist was created.
default_watchlist	boolean	Whether the specified watchlist is the default watchlist of a domain.
description	string	The description of the watchlist. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
domain_id	string	The identifier of the domain that contains the watchlist. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
name	string	The name for the watchlist. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_-]*$</code>)
updated_at	string (date-time)	The timestamp of when the watchlist was updated.
watchlist_id	string	The identifier of the watchlist. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)

list_watchlists

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the watchlist was created.
default_watchlist	boolean	Whether the specified watchlist is the default watchlist of a domain.
description	string	The description of the watchlist. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
domain_id	string	The identifier of the domain that contains the watchlist. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
name	string	The name for the watchlist. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_-]*$</code>)
updated_at	string (date-time)	The timestamp of when the watchlist was last updated.
watchlist_id	string	The identifier of the watchlist. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_watchlist	select	region		Describes the specified watchlist.
list_watchlists	select	region		Lists all watchlists in a specified domain.
create_watchlist	insert	region, DomainId		Creates a watchlist that fraudsters can be a part of.
update_watchlist	update	region, DomainId, WatchlistId		Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
delete_watchlist	delete	region		Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_watchlist

Describes the specified watchlist.

SELECT
created_at,
default_watchlist,
description,
domain_id,
name,
updated_at,
watchlist_id
FROM aws.voice_id.watchlists
WHERE region = '{{ region }}' -- required
;

list_watchlists

Lists all watchlists in a specified domain.

SELECT
created_at,
default_watchlist,
description,
domain_id,
name,
updated_at,
watchlist_id
FROM aws.voice_id.watchlists
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_watchlist

Creates a watchlist that fraudsters can be a part of.

INSERT INTO aws.voice_id.watchlists (
ClientToken,
Description,
DomainId,
Name,
region
)
SELECT 
'{{ ClientToken }}',
'{{ Description }}',
'{{ DomainId }}' /* required */,
'{{ Name }}',
'{{ region }}'
RETURNING
watchlist
;

Manifest

# Description fields are for documentation purposes
- name: watchlists
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the watchlists resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      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.
  - name: Description
    value: "{{ Description }}"
    description: |
      A brief description of this watchlist.
  - name: DomainId
    value: "{{ DomainId }}"
    description: |
      The identifier of the domain that contains the watchlist.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the watchlist.

UPDATE examples

update_watchlist

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

UPDATE aws.voice_id.watchlists
SET 
Description = '{{ Description }}',
DomainId = '{{ DomainId }}',
Name = '{{ Name }}',
WatchlistId = '{{ WatchlistId }}'
WHERE 
region = '{{ region }}' --required
AND DomainId = '{{ DomainId }}' --required
AND WatchlistId = '{{ WatchlistId }}' --required
RETURNING
watchlist;

DELETE examples

delete_watchlist

Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.

DELETE FROM aws.voice_id.watchlists
WHERE region = '{{ region }}' --required
;