Skip to content

list_lexicons

Operation

list_lexicons

list_lexicons(request: ListLexiconsInput | ListLexiconsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListLexiconsInputDict]) -> ListLexiconsOutput

Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.

Parameters:

Name Type Description Default
request ListLexiconsInput | ListLexiconsInputDict | 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[ListLexiconsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListLexiconsOutput

An instance of ListLexiconsOutput.

list_lexicons async

list_lexicons(request: ListLexiconsInput | ListLexiconsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListLexiconsInputDict]) -> ListLexiconsOutput

Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.

Parameters:

Name Type Description Default
request ListLexiconsInput | ListLexiconsInputDict | 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[ListLexiconsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListLexiconsOutput

An instance of ListLexiconsOutput.

Input

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

ListLexiconsInputDict

Bases: TypedDict

Dictionary form of ListLexiconsInput.

Attributes

next_token instance-attribute
next_token: str | None

An opaque pagination token returned from previous ListLexicons operation. If present, indicates where to continue the list of lexicons.

ListLexiconsInput dataclass

Bases: _SerdeShape

Dataclass for ListLexiconsInput structure.

Attributes

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

An opaque pagination token returned from previous ListLexicons operation. If present, indicates where to continue the list of lexicons.

Output

ListLexiconsOutput dataclass

Bases: _SerdeShape

Dataclass for ListLexiconsOutput structure.

Attributes

lexicons class-attribute instance-attribute
lexicons: list[LexiconDescription] | None = ...

A list of lexicon names and attributes.

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

The pagination token to use in the next request to continue the listing of lexicons. NextToken is returned only if the response is truncated.

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.