GetLexicon
Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.
Request Syntax
GET /v1/lexicons/LexiconName
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- LexiconName
-
Name of the lexicon.
Pattern:
[0-9A-Za-z]{1,20}
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Lexicon": {
"Content": "string",
"Name": "string"
},
"LexiconAttributes": {
"Alphabet": "string",
"LanguageCode": "string",
"LastModified": number,
"LexemesCount": number,
"LexiconArn": "string",
"Size": number
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Lexicon
-
Lexicon object that provides name and the string content of the lexicon.
Type: Lexicon object
- LexiconAttributes
-
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.
Type: LexiconAttributes object
Errors
- LexiconNotFoundException
-
Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.
HTTP Status Code: 404
- ServiceFailureException
-
An unknown condition has caused a service failure.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: