[ aws . polly ]

get-lexicon

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-lexicon
--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

Name of the lexicon.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve the content of a lexicon

The following get-lexicon example retrieves the content of the specified pronunciation lexicon.

aws polly get-lexicon \
    --name w3c

Output:

{
    "Lexicon": {
        "Content": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<lexicon version=\"1.0\" \n      xmlns=    \"http://www.w3.org/2005/01/pronunciation-lexicon\"\n      xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" \n          xsi:schemaLocation=\"http://www.w3.org/2005/01/pronunciation-lexicon \n        http://www.w3.org/TR/2007/CR-pronunciation-    lexicon-20071212/pls.xsd\"\n      alphabet=\"ipa\" \n      xml:lang=\"en-US\">\n  <lexeme>\n    <grapheme>W3C</grapheme>\n        <alias>World Wide Web Consortium</alias>\n  </lexeme>\n</lexicon>\n",
        "Name": "w3c"
    },
    "LexiconAttributes": {
        "Alphabet": "ipa",
        "LanguageCode": "en-US",
        "LastModified": 1603908910.99,
        "LexiconArn": "arn:aws:polly:us-west-2:880185128111:lexicon/w3c",
        "LexemesCount": 1,
        "Size": 492
    }
}

For more information, see Using the GetLexicon operation in the Amazon Polly Developer Guide.

Output

Lexicon -> (structure)

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

Content -> (string)

Lexicon content in string format. The content of a lexicon must be in PLS format.

Name -> (string)

Name of the lexicon.

LexiconAttributes -> (structure)

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.

Alphabet -> (string)

Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa .

LanguageCode -> (string)

Language code that the lexicon applies to. A lexicon with a language code such as “en” would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.

LastModified -> (timestamp)

Date lexicon was last modified (a timestamp value).

LexiconArn -> (string)

Amazon Resource Name (ARN) of the lexicon.

LexemesCount -> (integer)

Number of lexemes in the lexicon.

Size -> (integer)

Total size of the lexicon, in characters.