Skip to content

get_lexicon

Operation

get_lexicon

get_lexicon(request: GetLexiconInput | GetLexiconInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetLexiconInputDict]) -> 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
request GetLexiconInput | GetLexiconInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetLexiconInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetLexiconOutput

An instance of GetLexiconOutput.

get_lexicon async

get_lexicon(request: GetLexiconInput | GetLexiconInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetLexiconInputDict]) -> 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
request GetLexiconInput | GetLexiconInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetLexiconInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetLexiconOutput

An instance of GetLexiconOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetLexiconInputDict

Bases: TypedDict

Dictionary form of GetLexiconInput.

Attributes

name instance-attribute
name: Required[str]

Name of the lexicon.

GetLexiconInput dataclass

Bases: _SerdeShape

Dataclass for GetLexiconInput structure.

Attributes

name class-attribute instance-attribute
name: str | None = ...

Name of the lexicon.

Output

GetLexiconOutput dataclass

Bases: _SerdeShape

Dataclass for GetLexiconOutput structure.

Attributes

lexicon class-attribute instance-attribute
lexicon: Lexicon | None = ...

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

lexicon_attributes class-attribute instance-attribute
lexicon_attributes: LexiconAttributes | 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.