Polly  >  Operations  >  get_lexicon

get_lexicon

Operation

get_lexicon async

get_lexicon(input: GetLexiconInput, plugins: list[Plugin] | None = None) -> GetLexiconOutput

Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons.

Parameters:

Name	Type	Description	Default
input	GetLexiconInput	An instance of GetLexiconInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
GetLexiconOutput	An instance of GetLexiconOutput.

Input

GetLexiconInput dataclass

Dataclass for GetLexiconInput structure.

Attributes

name class-attribute instance-attribute

name: str | None = None

Name of the lexicon.

Output

GetLexiconOutput dataclass

Dataclass for GetLexiconOutput structure.

Attributes

lexicon class-attribute instance-attribute

lexicon: Lexicon | None = None

Lexicon object that provides name and the string content of the lexicon.

lexicon_attributes class-attribute instance-attribute

lexicon_attributes: LexiconAttributes | None = None

Metadata of the lexicon, including phonetic alphabetic used, language code, lexicon ARN, number of lexemes defined in the lexicon, and size of lexicon in bytes.