vocabularies

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

Overview

Name	vocabularies
Type	Resource
Id	aws.connect.vocabularies

Fields

The following fields are returned by SELECT queries:

describe_vocabulary

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the custom vocabulary.
content	string	The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
failure_reason	string	The reason why the custom vocabulary was not created.
id	string	The identifier of the custom vocabulary.
language_code	string	The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe? (ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH)
last_modified_time	string (date-time)	The timestamp when the custom vocabulary was last modified.
name	string	A unique name of the custom vocabulary. (pattern: <code>^[0-9a-zA-Z._-]+</code>)
state	string	The current state of the custom vocabulary. (CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS)
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

search_vocabularies

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the custom vocabulary.
failure_reason	string	The reason why the custom vocabulary was not created.
id	string	The identifier of the custom vocabulary.
language_code	string	The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe? (ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH)
last_modified_time	string (date-time)	The timestamp when the custom vocabulary was last modified.
name	string	A unique name of the custom vocabulary. (pattern: <code>^[0-9a-zA-Z._-]+</code>)
state	string	The current state of the custom vocabulary. (CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vocabulary	select	instance_id, vocabulary_id, region		Describes the specified vocabulary.
search_vocabularies	select	instance_id, region		Searches for vocabularies within a specific Connect Customer instance using State, NameStartsWith, and LanguageCode.
create_vocabulary	insert	instance_id, region, VocabularyName, LanguageCode, Content		Creates a custom vocabulary associated with your Connect Customer instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Connect Customer uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
delete_vocabulary	delete	instance_id, vocabulary_id, region		Deletes the vocabulary that has the given identifier.

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
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
vocabulary_id	string	The identifier of the custom vocabulary.

SELECT examples

describe_vocabulary

Describes the specified vocabulary.

SELECT
arn,
content,
failure_reason,
id,
language_code,
last_modified_time,
name,
state,
tags
FROM aws.connect.vocabularies
WHERE instance_id = '{{ instance_id }}' -- required
AND vocabulary_id = '{{ vocabulary_id }}' -- required
AND region = '{{ region }}' -- required
;

search_vocabularies

Searches for vocabularies within a specific Connect Customer instance using State, NameStartsWith, and LanguageCode.

SELECT
arn,
failure_reason,
id,
language_code,
last_modified_time,
name,
state
FROM aws.connect.vocabularies
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_vocabulary

Creates a custom vocabulary associated with your Connect Customer instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Connect Customer uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

INSERT INTO aws.connect.vocabularies (
ClientToken,
VocabularyName,
LanguageCode,
Content,
Tags,
instance_id,
region
)
SELECT 
'{{ ClientToken }}',
'{{ VocabularyName }}' /* required */,
'{{ LanguageCode }}' /* required */,
'{{ Content }}' /* required */,
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
state,
vocabulary_arn,
vocabulary_id
;

Manifest

# Description fields are for documentation purposes
- name: vocabularies
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the vocabularies resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vocabularies resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: VocabularyName
    value: "{{ VocabularyName }}"
  - name: LanguageCode
    value: "{{ LanguageCode }}"
    valid_values: ['ar-AE', 'de-CH', 'de-DE', 'en-AB', 'en-AU', 'en-GB', 'en-IE', 'en-IN', 'en-US', 'en-WL', 'es-ES', 'es-US', 'fr-CA', 'fr-FR', 'hi-IN', 'it-IT', 'ja-JP', 'ko-KR', 'pt-BR', 'pt-PT', 'zh-CN', 'en-NZ', 'en-ZA', 'ca-ES', 'da-DK', 'fi-FI', 'id-ID', 'ms-MY', 'nl-NL', 'no-NO', 'pl-PL', 'sv-SE', 'tl-PH']
  - name: Content
    value: "{{ Content }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_vocabulary

Deletes the vocabulary that has the given identifier.

DELETE FROM aws.connect.vocabularies
WHERE instance_id = '{{ instance_id }}' --required
AND vocabulary_id = '{{ vocabulary_id }}' --required
AND region = '{{ region }}' --required
;