Skip to content

delete_lexicon

Operation

delete_lexicon

delete_lexicon(request: DeleteLexiconInput | DeleteLexiconInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteLexiconInputDict]) -> DeleteLexiconOutput

Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs.

For more information, see Managing Lexicons.

Parameters:

Name Type Description Default
request DeleteLexiconInput | DeleteLexiconInputDict | 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[DeleteLexiconInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteLexiconOutput

An instance of DeleteLexiconOutput.

delete_lexicon async

delete_lexicon(request: DeleteLexiconInput | DeleteLexiconInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteLexiconInputDict]) -> DeleteLexiconOutput

Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs.

For more information, see Managing Lexicons.

Parameters:

Name Type Description Default
request DeleteLexiconInput | DeleteLexiconInputDict | 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[DeleteLexiconInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteLexiconOutput

An instance of DeleteLexiconOutput.

Input

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

DeleteLexiconInputDict

Bases: TypedDict

Dictionary form of DeleteLexiconInput.

Attributes

name instance-attribute
name: Required[str]

The name of the lexicon to delete. Must be an existing lexicon in the region.

DeleteLexiconInput dataclass

Bases: _SerdeShape

Dataclass for DeleteLexiconInput structure.

Attributes

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

The name of the lexicon to delete. Must be an existing lexicon in the region.

Output

DeleteLexiconOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteLexiconOutput structure.

Attributes

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.