dictionaries

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

Overview

Name	dictionaries
Type	Resource
Id	aws.elementalinference.dictionaries

Fields

The following fields are returned by SELECT queries:

get_dictionary

Name	Datatype	Description
id	string	The ID of the dictionary. (pattern: <code>[a-zA-Z0-9]+</code>)
name	string	The name of the dictionary. (pattern: <code>[a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?</code>)
arn	string	The ARN of the dictionary.
language	string	The language of the dictionary. (eng, fra, ita, deu, spa, por)
references	array	A list of feed IDs that reference this dictionary.
status	string	The current status of the dictionary. (CREATING, AVAILABLE, REFERENCED, DELETING, DELETED)
tags	object	The tags associated with the dictionary.

list_dictionaries

Name	Datatype	Description
id	string	The ID of the dictionary. (pattern: <code>[a-zA-Z0-9]+</code>)
name	string	The name of the dictionary. (pattern: <code>[a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?</code>)
arn	string	The ARN of the dictionary.
language	string	The language of the dictionary. (eng, fra, ita, deu, spa, por)
status	string	The status of the dictionary. (CREATING, AVAILABLE, REFERENCED, DELETING, DELETED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dictionary	select	id, region		Retrieves information about the specified dictionary.
list_dictionaries	select	region	maxResults, nextToken	Lists the dictionaries in your account.
create_dictionary	insert	region, name, language		Creates a custom dictionary for improving transcription accuracy. A dictionary contains custom words and phrases that the ASR engine might not recognize, such as brand names, technical terms, or proper nouns. You can reference a dictionary when configuring a smart subtitles output.
update_dictionary	update	id, region		Updates the specified dictionary.
delete_dictionary	delete	id, region		Deletes the specified dictionary. You cannot delete a dictionary that is referenced by a feed. You must first remove the dictionary reference from the feed's subtitling configuration.
export_dictionary_entries	exec	id, region		Exports the entries from the specified dictionary.

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
id	string	The ID of the dictionary whose entries you want to export.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per API request. Valid range: 1 to 100.
nextToken	string	The token that identifies the next batch of results to return.

SELECT examples

get_dictionary

Retrieves information about the specified dictionary.

SELECT
id,
name,
arn,
language,
references,
status,
tags
FROM aws.elementalinference.dictionaries
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_dictionaries

Lists the dictionaries in your account.

SELECT
id,
name,
arn,
language,
status
FROM aws.elementalinference.dictionaries
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_dictionary

Creates a custom dictionary for improving transcription accuracy. A dictionary contains custom words and phrases that the ASR engine might not recognize, such as brand names, technical terms, or proper nouns. You can reference a dictionary when configuring a smart subtitles output.

INSERT INTO aws.elementalinference.dictionaries (
name,
language,
entries,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ language }}' /* required */,
'{{ entries }}',
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
arn,
language,
references,
status,
tags
;

Manifest

# Description fields are for documentation purposes
- name: dictionaries
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the dictionaries resource.
  - name: name
    value: "{{ name }}"
  - name: language
    value: "{{ language }}"
    valid_values: ['eng', 'fra', 'ita', 'deu', 'spa', 'por']
  - name: entries
    value: "{{ entries }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_dictionary

Updates the specified dictionary.

UPDATE aws.elementalinference.dictionaries
SET 
name = '{{ name }}',
language = '{{ language }}',
entries = '{{ entries }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
arn,
language,
references,
status,
tags;

DELETE examples

delete_dictionary

Deletes the specified dictionary. You cannot delete a dictionary that is referenced by a feed. You must first remove the dictionary reference from the feed's subtitling configuration.

DELETE FROM aws.elementalinference.dictionaries
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

export_dictionary_entries

Exports the entries from the specified dictionary.

EXEC aws.elementalinference.dictionaries.export_dictionary_entries 
@id='{{ id }}' --required, 
@region='{{ region }}' --required
;