Skip to content

Polly  >  Operations  >  delete_lexicon

delete_lexicon

Operation

delete_lexicon async 

delete_lexicon(input: DeleteLexiconInput, plugins: list[Plugin] | None = None) -> 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
input DeleteLexiconInput

An instance of DeleteLexiconInput.

 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
DeleteLexiconOutput

An instance of DeleteLexiconOutput.

Input

DeleteLexiconInput dataclass

Dataclass for DeleteLexiconInput structure.

Attributes

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

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

Output

DeleteLexiconOutput dataclass

Dataclass for DeleteLexiconOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.