[ aws . polly ]

list-lexicons

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-lexicons is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Lexicons

Synopsis

  list-lexicons
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 list your lexicons

The following list-lexicons example lists your pronunciation lexicons.

aws polly list-lexicons

Output:

{
    "Lexicons": [
        {
            "Name": "w3c",
            "Attributes": {
                "Alphabet": "ipa",
                "LanguageCode": "en-US",
                "LastModified": 1603908910.99,
                "LexiconArn": "arn:aws:polly:us-east-2:123456789012:lexicon/w3c",
                "LexemesCount": 1,
                "Size": 492
            }
        }
    ]
}

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

Output

Lexicons -> (list)

A list of lexicon names and attributes.

(structure)

Describes the content of the lexicon.

Name -> (string)

Name of the lexicon.

Attributes -> (structure)

Provides lexicon metadata.

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.

NextToken -> (string)

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