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.
" }, "DescribeVoices":{ "name":"DescribeVoices", "http":{ "method":"GET", "requestUri":"/v1/voices", "responseCode":200 }, "input":{"shape":"DescribeVoicesInput"}, "output":{"shape":"DescribeVoicesOutput"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"ServiceFailureException"} ], "documentation":"Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name.
When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices returned by DescribeVoices.
For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the DescribeVoices operation you can provide the user with a list of available voices to select from.
You can optionally specify a language code to filter the available voices. For example, if you specify en-US, the operation returns a list of all available US English voices.
This operation requires permissions to perform the polly:DescribeVoices action.
Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
" }, "GetSpeechSynthesisTask":{ "name":"GetSpeechSynthesisTask", "http":{ "method":"GET", "requestUri":"/v1/synthesisTasks/{TaskId}", "responseCode":200 }, "input":{"shape":"GetSpeechSynthesisTaskInput"}, "output":{"shape":"GetSpeechSynthesisTaskOutput"}, "errors":[ {"shape":"InvalidTaskIdException"}, {"shape":"ServiceFailureException"}, {"shape":"SynthesisTaskNotFoundException"} ], "documentation":"Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.
" }, "ListLexicons":{ "name":"ListLexicons", "http":{ "method":"GET", "requestUri":"/v1/lexicons", "responseCode":200 }, "input":{"shape":"ListLexiconsInput"}, "output":{"shape":"ListLexiconsOutput"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"ServiceFailureException"} ], "documentation":"Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
" }, "ListSpeechSynthesisTasks":{ "name":"ListSpeechSynthesisTasks", "http":{ "method":"GET", "requestUri":"/v1/synthesisTasks", "responseCode":200 }, "input":{"shape":"ListSpeechSynthesisTasksInput"}, "output":{"shape":"ListSpeechSynthesisTasksOutput"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"ServiceFailureException"} ], "documentation":"Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.
" }, "PutLexicon":{ "name":"PutLexicon", "http":{ "method":"PUT", "requestUri":"/v1/lexicons/{LexiconName}", "responseCode":200 }, "input":{"shape":"PutLexiconInput"}, "output":{"shape":"PutLexiconOutput"}, "errors":[ {"shape":"InvalidLexiconException"}, {"shape":"UnsupportedPlsAlphabetException"}, {"shape":"UnsupportedPlsLanguageException"}, {"shape":"LexiconSizeExceededException"}, {"shape":"MaxLexemeLengthExceededException"}, {"shape":"MaxLexiconsNumberExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"Stores a pronunciation lexicon in an Amazon Web Services Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.
For more information, see Managing Lexicons.
" }, "StartSpeechSynthesisStream":{ "name":"StartSpeechSynthesisStream", "http":{ "method":"POST", "requestUri":"/v1/synthesisStream" }, "input":{"shape":"StartSpeechSynthesisStreamInput"}, "output":{"shape":"StartSpeechSynthesisStreamOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ServiceFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Synthesizes UTF-8 input, plain text, or SSML over a bidirectional streaming connection. Specify synthesis parameters in HTTP/2 headers, send text incrementally as events on the input stream, and receive synthesized audio as it becomes available.
This operation serves as a bidirectional counterpart to SynthesizeSpeech:
Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.
Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.
" } }, "shapes":{ "Alphabet":{"type":"string"}, "AudioChunk":{"type":"blob"}, "AudioEvent":{ "type":"structure", "members":{ "AudioChunk":{ "shape":"AudioChunk", "documentation":"A chunk of synthesized audio data encoded in the format specified by the OutputFormat parameter.
Contains a chunk of synthesized audio data.
", "event":true }, "AudioStream":{ "type":"blob", "streaming":true }, "AvailabilityErrorMessage":{"type":"string"}, "CloseStreamEvent":{ "type":"structure", "members":{}, "documentation":"Indicates the end of the input stream. After sending this event, the input stream will be closed and all audio will be returned.
", "event":true }, "ContentType":{"type":"string"}, "CoralAvailabilityThrottledResource":{"type":"string"}, "CoralAvailabilityThrottlingReason":{"type":"string"}, "DateTime":{"type":"timestamp"}, "DeleteLexiconInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"LexiconName", "documentation":"The name of the lexicon to delete. Must be an existing lexicon in the region.
", "location":"uri", "locationName":"LexiconName" } } }, "DeleteLexiconOutput":{ "type":"structure", "members":{} }, "DescribeVoicesInput":{ "type":"structure", "members":{ "Engine":{ "shape":"Engine", "documentation":"Specifies the engine (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.
The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.
", "location":"querystring", "locationName":"LanguageCode" }, "IncludeAdditionalLanguageCodes":{ "shape":"IncludeAdditionalLanguageCodes", "documentation":"Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.
An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.
A list of voices with their properties.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The pagination token to use in the next request to continue the listing of voices. NextToken is returned only if the response is truncated.
This engine is not compatible with the voice that you have designated. Choose a new voice that is compatible with the engine or change the engine and restart the operation.
", "error":{"httpStatusCode":400}, "exception":true }, "ErrorMessage":{"type":"string"}, "FlushStreamConfiguration":{ "type":"structure", "members":{ "Force":{ "shape":"Force", "documentation":"Specifies whether to force the synthesis engine to immediately write buffered audio data to the output stream.
" } }, "documentation":"Configuration that controls when synthesized audio data is sent on the output stream.
" }, "Force":{"type":"boolean"}, "Gender":{ "type":"string", "enum":[ "Female", "Male" ] }, "GetLexiconInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"LexiconName", "documentation":"Name of the lexicon.
", "location":"uri", "locationName":"LexiconName" } } }, "GetLexiconOutput":{ "type":"structure", "members":{ "Lexicon":{ "shape":"Lexicon", "documentation":"Lexicon object that provides name and the string content of the lexicon.
" }, "LexiconAttributes":{ "shape":"LexiconAttributes", "documentation":"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.
" } } }, "GetSpeechSynthesisTaskInput":{ "type":"structure", "required":["TaskId"], "members":{ "TaskId":{ "shape":"TaskId", "documentation":"The Amazon Polly generated identifier for a speech synthesis task.
", "location":"uri", "locationName":"TaskId" } } }, "GetSpeechSynthesisTaskOutput":{ "type":"structure", "members":{ "SynthesisTask":{ "shape":"SynthesisTask", "documentation":"SynthesisTask object that provides information from the requested task, including output format, creation time, task status, and so on.
" } } }, "IncludeAdditionalLanguageCodes":{"type":"boolean"}, "InvalidLexiconException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The NextToken is invalid. Verify that it's spelled correctly, and then try again.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidS3BucketException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements and try again.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidS3KeyException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidSampleRateException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The specified sample rate is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidSnsTopicArnException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidSsmlException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidTaskIdException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The provided Task ID is not valid. Please provide a valid Task ID and try again.
", "error":{"httpStatusCode":400}, "exception":true }, "LanguageCode":{ "type":"string", "enum":[ "arb", "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "is-IS", "it-IT", "ja-JP", "hi-IN", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG" ] }, "LanguageCodeList":{ "type":"list", "member":{"shape":"LanguageCode"} }, "LanguageName":{"type":"string"}, "LanguageNotSupportedException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The language specified is not currently supported by Amazon Polly in this capacity.
", "error":{"httpStatusCode":400}, "exception":true }, "LastModified":{"type":"timestamp"}, "LexemesCount":{"type":"integer"}, "Lexicon":{ "type":"structure", "members":{ "Content":{ "shape":"LexiconContent", "documentation":"Lexicon content in string format. The content of a lexicon must be in PLS format.
" }, "Name":{ "shape":"LexiconName", "documentation":"Name of the lexicon.
" } }, "documentation":"Provides lexicon name and lexicon content in string format. For more information, see Pronunciation Lexicon Specification (PLS) Version 1.0.
" }, "LexiconArn":{"type":"string"}, "LexiconAttributes":{ "type":"structure", "members":{ "Alphabet":{ "shape":"Alphabet", "documentation":"Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.
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":{ "shape":"LastModified", "documentation":"Date lexicon was last modified (a timestamp value).
" }, "LexiconArn":{ "shape":"LexiconArn", "documentation":"Amazon Resource Name (ARN) of the lexicon.
" }, "LexemesCount":{ "shape":"LexemesCount", "documentation":"Number of lexemes in the lexicon.
" }, "Size":{ "shape":"Size", "documentation":"Total size of the lexicon, in characters.
" } }, "documentation":"Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons.
" }, "LexiconContent":{ "type":"string", "sensitive":true }, "LexiconDescription":{ "type":"structure", "members":{ "Name":{ "shape":"LexiconName", "documentation":"Name of the lexicon.
" }, "Attributes":{ "shape":"LexiconAttributes", "documentation":"Provides lexicon metadata.
" } }, "documentation":"Describes the content of the lexicon.
" }, "LexiconDescriptionList":{ "type":"list", "member":{"shape":"LexiconDescription"} }, "LexiconName":{ "type":"string", "pattern":"[0-9A-Za-z]{1,20}" }, "LexiconNameList":{ "type":"list", "member":{"shape":"LexiconName"}, "max":5 }, "LexiconNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"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.
", "error":{"httpStatusCode":404}, "exception":true }, "LexiconSizeExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The maximum size of the specified lexicon would be exceeded by this operation.
", "error":{"httpStatusCode":400}, "exception":true }, "ListLexiconsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"An opaque pagination token returned from previous ListLexicons operation. If present, indicates where to continue the list of lexicons.
A list of lexicon names and attributes.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The pagination token to use in the next request to continue the listing of lexicons. NextToken is returned only if the response is truncated.
Maximum number of speech synthesis tasks returned in a List operation.
", "location":"querystring", "locationName":"MaxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"The pagination token to use in the next request to continue the listing of speech synthesis tasks.
", "location":"querystring", "locationName":"NextToken" }, "Status":{ "shape":"TaskStatus", "documentation":"Status of the speech synthesis tasks returned in a List operation
", "location":"querystring", "locationName":"Status" } } }, "ListSpeechSynthesisTasksOutput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.
" }, "SynthesisTasks":{ "shape":"SynthesisTasks", "documentation":"List of SynthesisTask objects that provides information from the specified task in the list request, including output format, creation time, task status, and so on.
" } } }, "MarksNotSupportedForFormatException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"Speech marks are not supported for the OutputFormat selected. Speech marks are only available for content in json format.
The maximum size of the lexeme would be exceeded by this operation.
", "error":{"httpStatusCode":400}, "exception":true }, "MaxLexiconsNumberExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The maximum number of lexicons would be exceeded by this operation.
", "error":{"httpStatusCode":400}, "exception":true }, "MaxResults":{ "type":"integer", "max":100, "min":1 }, "NextToken":{ "type":"string", "max":4096, "min":0 }, "OutputFormat":{ "type":"string", "enum":[ "json", "mp3", "ogg_opus", "ogg_vorbis", "pcm", "mulaw", "alaw" ] }, "OutputS3BucketName":{ "type":"string", "pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" }, "OutputS3KeyPrefix":{ "type":"string", "pattern":"^[0-9a-zA-Z\\/\\!\\-_\\.\\*\\'\\(\\):;\\$@=+\\,\\?&]{0,800}$" }, "OutputUri":{"type":"string"}, "PutLexiconInput":{ "type":"structure", "required":[ "Name", "Content" ], "members":{ "Name":{ "shape":"LexiconName", "documentation":"Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive alphanumeric string up to 20 characters long.
", "location":"uri", "locationName":"LexiconName" }, "Content":{ "shape":"LexiconContent", "documentation":"Content of the PLS lexicon as string data.
" } } }, "PutLexiconOutput":{ "type":"structure", "members":{} }, "QuotaCode":{ "type":"string", "enum":[ "input-stream-inbound-event-timeout", "input-stream-timeout" ] }, "RequestCharacters":{"type":"integer"}, "SampleRate":{"type":"string"}, "ServiceCode":{ "type":"string", "enum":["polly"] }, "ServiceFailureException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"An unknown condition has caused a service failure.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "message", "quotaCode", "serviceCode" ], "members":{ "message":{"shape":"ErrorMessage"}, "quotaCode":{ "shape":"QuotaCode", "documentation":"The quota code identifying the specific quota.
" }, "serviceCode":{ "shape":"ServiceCode", "documentation":"The service code identifying the originating service.
" } }, "documentation":"The request would cause a service quota to be exceeded.
", "error":{"httpStatusCode":402}, "exception":true }, "Size":{"type":"integer"}, "SnsTopicArn":{ "type":"string", "pattern":"^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0-9_-]{1,50}:\\d{12}:[a-zA-Z0-9_-]{1,251}([a-zA-Z0-9_-]{0,5}|\\.fifo)$" }, "SpeechMarkType":{ "type":"string", "enum":[ "sentence", "ssml", "viseme", "word" ] }, "SpeechMarkTypeList":{ "type":"list", "member":{"shape":"SpeechMarkType"}, "max":4 }, "SsmlMarksNotSupportedForTextTypeException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"SSML speech marks are not supported for plain text-type input.
", "error":{"httpStatusCode":400}, "exception":true }, "StartSpeechSynthesisStreamActionStream":{ "type":"structure", "members":{ "TextEvent":{ "shape":"TextEvent", "documentation":"A text event containing content to be synthesized.
" }, "CloseStreamEvent":{ "shape":"CloseStreamEvent", "documentation":"An event indicating the end of the input stream.
" } }, "documentation":"Inbound event stream for sending input and control events to manage bidirectional speech synthesis.
", "eventstream":true }, "StartSpeechSynthesisStreamEventStream":{ "type":"structure", "members":{ "AudioEvent":{ "shape":"AudioEvent", "documentation":"An audio event containing synthesized speech.
" }, "StreamClosedEvent":{ "shape":"StreamClosedEvent", "documentation":"An event, with summary information, indicating the stream has closed.
" }, "ValidationException":{ "shape":"ValidationException", "documentation":"An exception indicating the input failed validation.
" }, "ServiceQuotaExceededException":{ "shape":"ServiceQuotaExceededException", "documentation":"An exception indicating a service quota would be exceeded.
" }, "ServiceFailureException":{"shape":"ServiceFailureException"}, "ThrottlingException":{ "shape":"ThrottlingException", "documentation":"An exception indicating the request was throttled.
" } }, "documentation":"Outbound event stream that contains synthesized audio data and stream status events.
", "eventstream":true }, "StartSpeechSynthesisStreamInput":{ "type":"structure", "required":[ "Engine", "OutputFormat", "VoiceId" ], "members":{ "Engine":{ "shape":"Engine", "documentation":"Specifies the engine for Amazon Polly to use when processing input text for speech synthesis. Currently, only the generative engine is supported. If you specify a voice that the selected engine doesn't support, Amazon Polly returns an error.
An optional parameter that sets the language code for the speech synthesis request. Specify this parameter only when using a bilingual voice. If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice.
", "location":"header", "locationName":"x-amzn-LanguageCode" }, "LexiconNames":{ "shape":"LexiconNameList", "documentation":"The names of one or more pronunciation lexicons for the service to apply during synthesis. Amazon Polly applies lexicons only when the lexicon language matches the voice language.
", "location":"header", "locationName":"x-amzn-LexiconNames" }, "OutputFormat":{ "shape":"OutputFormat", "documentation":"The audio format for the synthesized speech. Currently, Amazon Polly does not support JSON speech marks.
", "location":"header", "locationName":"x-amzn-OutputFormat" }, "SampleRate":{ "shape":"SampleRate", "documentation":"The audio frequency, specified in Hz.
", "location":"header", "locationName":"x-amzn-SampleRate" }, "VoiceId":{ "shape":"VoiceId", "documentation":"The voice to use in synthesis. To get a list of available voice IDs, use the DescribeVoices operation.
", "location":"header", "locationName":"x-amzn-VoiceId" }, "ActionStream":{ "shape":"StartSpeechSynthesisStreamActionStream", "documentation":"The input event stream that contains text events and stream control events.
" } }, "payload":"ActionStream" }, "StartSpeechSynthesisStreamOutput":{ "type":"structure", "members":{ "EventStream":{ "shape":"StartSpeechSynthesisStreamEventStream", "documentation":"The output event stream that contains synthesized audio events and stream status events.
" } }, "payload":"EventStream" }, "StartSpeechSynthesisTaskInput":{ "type":"structure", "required":[ "OutputFormat", "OutputS3BucketName", "Text", "VoiceId" ], "members":{ "Engine":{ "shape":"Engine", "documentation":"Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.
List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.
" }, "OutputFormat":{ "shape":"OutputFormat", "documentation":"The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, ogg_opus, mu-law, a-law, or pcm. For speech marks, this will be json.
" }, "OutputS3BucketName":{ "shape":"OutputS3BucketName", "documentation":"Amazon S3 bucket name to which the output file will be saved.
" }, "OutputS3KeyPrefix":{ "shape":"OutputS3KeyPrefix", "documentation":"The Amazon S3 key prefix for the output speech file.
" }, "SampleRate":{ "shape":"SampleRate", "documentation":"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\". The default value for generative voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
Valid value for ogg_opus is \"48000\".
Valid value for mu-law and a-law is \"8000\".
" }, "SnsTopicArn":{ "shape":"SnsTopicArn", "documentation":"ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
" }, "SpeechMarkTypes":{ "shape":"SpeechMarkTypeList", "documentation":"The type of speech marks returned for the input text.
" }, "Text":{ "shape":"Text", "documentation":"The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
" }, "TextType":{ "shape":"TextType", "documentation":"Specifies whether the input text is plain text or SSML. The default value is plain text.
" }, "VoiceId":{ "shape":"VoiceId", "documentation":"Voice ID to use for the synthesis.
" } } }, "StartSpeechSynthesisTaskOutput":{ "type":"structure", "members":{ "SynthesisTask":{ "shape":"SynthesisTask", "documentation":"SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.
" } } }, "StreamClosedEvent":{ "type":"structure", "members":{ "RequestCharacters":{ "shape":"RequestCharacters", "documentation":"The total number of characters synthesized during the streaming session.
" } }, "documentation":"Indicates that the synthesis stream is closed and provides summary information.
", "event":true }, "SynthesisTask":{ "type":"structure", "members":{ "Engine":{ "shape":"Engine", "documentation":"Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
The Amazon Polly generated identifier for a speech synthesis task.
" }, "TaskStatus":{ "shape":"TaskStatus", "documentation":"Current status of the individual speech synthesis task.
" }, "TaskStatusReason":{ "shape":"TaskStatusReason", "documentation":"Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
" }, "OutputUri":{ "shape":"OutputUri", "documentation":"Pathway for the output speech file.
" }, "CreationTime":{ "shape":"DateTime", "documentation":"Timestamp for the time the synthesis task was started.
" }, "RequestCharacters":{ "shape":"RequestCharacters", "documentation":"Number of billable characters synthesized.
" }, "SnsTopicArn":{ "shape":"SnsTopicArn", "documentation":"ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
" }, "LexiconNames":{ "shape":"LexiconNameList", "documentation":"List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.
" }, "OutputFormat":{ "shape":"OutputFormat", "documentation":"The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, ogg_opus, mu-law, a-law, or pcm. For speech marks, this will be json.
" }, "SampleRate":{ "shape":"SampleRate", "documentation":"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\". The default value for generative voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
Valid value for ogg_opus is \"48000\".
Valid value for mu-law and a-law is \"8000\".
" }, "SpeechMarkTypes":{ "shape":"SpeechMarkTypeList", "documentation":"The type of speech marks returned for the input text.
" }, "TextType":{ "shape":"TextType", "documentation":"Specifies whether the input text is plain text or SSML. The default value is plain text.
" }, "VoiceId":{ "shape":"VoiceId", "documentation":"Voice ID to use for the synthesis.
" }, "LanguageCode":{ "shape":"LanguageCode", "documentation":"Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.
SynthesisTask object that provides information about a speech synthesis task.
" }, "SynthesisTaskNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The Speech Synthesis task with requested Task ID cannot be found.
", "error":{"httpStatusCode":400}, "exception":true }, "SynthesisTasks":{ "type":"list", "member":{"shape":"SynthesisTask"} }, "SynthesizeSpeechInput":{ "type":"structure", "required":[ "OutputFormat", "Text", "VoiceId" ], "members":{ "Engine":{ "shape":"Engine", "documentation":"Specifies the engine (standard, neural, long-form, or generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.
List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.
" }, "OutputFormat":{ "shape":"OutputFormat", "documentation":"The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, ogg_opus, mu-law, a-law or pcm. For speech marks, this will be json.
When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
" }, "SampleRate":{ "shape":"SampleRate", "documentation":"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", \"24000\", \"44100\" and \"48000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\". The default value for generative voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
Valid value for ogg_opus is \"48000\".
Valid value for mu-law and a-law is \"8000\".
" }, "SpeechMarkTypes":{ "shape":"SpeechMarkTypeList", "documentation":"The type of speech marks returned for the input text.
" }, "Text":{ "shape":"Text", "documentation":" Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.
" }, "VoiceId":{ "shape":"VoiceId", "documentation":"Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
" } } }, "SynthesizeSpeechOutput":{ "type":"structure", "members":{ "AudioStream":{ "shape":"AudioStream", "documentation":"Stream containing the synthesized speech.
" }, "ContentType":{ "shape":"ContentType", "documentation":" Specifies the type audio stream. This should reflect the OutputFormat parameter in your request.
If you request mp3 as the OutputFormat, the ContentType returned is audio/mpeg.
If you request ogg_vorbis as the OutputFormat, the ContentType returned is audio/ogg.
If you request ogg_opus as the OutputFormat, the ContentType returned is audio/ogg.
If you request pcm as the OutputFormat, the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
If you request mu-law as the OutputFormat, the ContentType returned is audio/mulaw.
If you request a-law as the OutputFormat, the ContentType returned is audio/alaw.
If you request json as the OutputFormat, the ContentType returned is application/x-json-stream.
", "location":"header", "locationName":"Content-Type" }, "RequestCharacters":{ "shape":"RequestCharacters", "documentation":"
Number of characters synthesized.
", "location":"header", "locationName":"x-amzn-RequestCharacters" } }, "payload":"AudioStream" }, "TaskId":{ "type":"string", "pattern":"^[a-zA-Z0-9_-]{1,100}$" }, "TaskStatus":{ "type":"string", "enum":[ "scheduled", "inProgress", "completed", "failed" ] }, "TaskStatusReason":{"type":"string"}, "Text":{"type":"string"}, "TextEvent":{ "type":"structure", "required":["Text"], "members":{ "Text":{ "shape":"Text", "documentation":"The text content to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
Specifies whether the input text is plain text or SSML. Default: plain text.
" }, "FlushStreamConfiguration":{ "shape":"FlushStreamConfiguration", "documentation":"Configuration for controlling when synthesized audio flushes to the output stream.
" } }, "documentation":"Contains text content to be synthesized into speech.
", "event":true }, "TextLengthExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The value of the \"Text\" parameter is longer than the accepted limits. For the SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not counted as billed characters.
A list of reasons explaining why the request was throttled.
" } }, "documentation":"The request was denied because of request throttling.
", "error":{"httpStatusCode":400}, "exception":true, "synthetic":true }, "ThrottlingReason":{ "type":"structure", "members":{ "reason":{ "shape":"CoralAvailabilityThrottlingReason", "documentation":"The reason code explaining why the request was throttled.
" }, "resource":{ "shape":"CoralAvailabilityThrottledResource", "documentation":"The resource that caused the throttling.
" } }, "documentation":"Provides information about a specific throttling reason.
" }, "ThrottlingReasonList":{ "type":"list", "member":{"shape":"ThrottlingReason"} }, "UnsupportedPlsAlphabetException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The alphabet specified by the lexicon is not a supported alphabet. Valid values are x-sampa and ipa.
The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes.
", "error":{"httpStatusCode":400}, "exception":true }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "message":{"shape":"ErrorMessage"}, "reason":{ "shape":"ValidationExceptionReason", "documentation":"The reason the request failed validation.
" }, "fields":{ "shape":"ValidationExceptionFieldList", "documentation":"The fields that caused the validation error.
" } }, "documentation":"The input fails to satisfy the constraints specified by the service.
", "error":{"httpStatusCode":400}, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{ "shape":"ValidationExceptionFieldName", "documentation":"The name of the field that failed validation.
" }, "message":{ "shape":"ValidationExceptionFieldMessage", "documentation":"A message describing why the field failed validation.
" } }, "documentation":"Information about a field that failed validation.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionFieldMessage":{"type":"string"}, "ValidationExceptionFieldName":{"type":"string"}, "ValidationExceptionReason":{ "type":"string", "enum":[ "unsupportedOperation", "fieldValidationFailed", "other", "invalidInboundEvent" ] }, "Voice":{ "type":"structure", "members":{ "Gender":{ "shape":"Gender", "documentation":"Gender of the voice.
" }, "Id":{ "shape":"VoiceId", "documentation":"Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
Language code of the voice.
" }, "LanguageName":{ "shape":"LanguageName", "documentation":"Human readable name of the language in English.
" }, "Name":{ "shape":"VoiceName", "documentation":"Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
" }, "AdditionalLanguageCodes":{ "shape":"LanguageCodeList", "documentation":"Additional codes for languages available for the specified voice in addition to its default language.
For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
Description of the voice.
" }, "VoiceId":{ "type":"string", "enum":[ "Aditi", "Amy", "Astrid", "Bianca", "Brian", "Camila", "Carla", "Carmen", "Celine", "Chantal", "Conchita", "Cristiano", "Dora", "Emma", "Enrique", "Ewa", "Filiz", "Gabrielle", "Geraint", "Giorgio", "Gwyneth", "Hans", "Ines", "Ivy", "Jacek", "Jan", "Joanna", "Joey", "Justin", "Karl", "Kendra", "Kevin", "Kimberly", "Lea", "Liv", "Lotte", "Lucia", "Lupe", "Mads", "Maja", "Marlene", "Mathieu", "Matthew", "Maxim", "Mia", "Miguel", "Mizuki", "Naja", "Nicole", "Olivia", "Penelope", "Raveena", "Ricardo", "Ruben", "Russell", "Salli", "Seoyeon", "Takumi", "Tatyana", "Vicki", "Vitoria", "Zeina", "Zhiyu", "Aria", "Ayanda", "Arlet", "Hannah", "Arthur", "Daniel", "Liam", "Pedro", "Kajal", "Hiujin", "Laura", "Elin", "Ida", "Suvi", "Ola", "Hala", "Andres", "Sergio", "Remi", "Adriano", "Thiago", "Ruth", "Stephen", "Kazuha", "Tomoko", "Niamh", "Sofie", "Lisa", "Isabelle", "Zayd", "Danielle", "Gregory", "Burcu", "Jitka", "Sabrina", "Jasmine", "Jihye", "Ambre", "Beatrice", "Florian", "Lennart", "Lorenzo", "Tiffany" ] }, "VoiceList":{ "type":"list", "member":{"shape":"Voice"} }, "VoiceName":{"type":"string"} }, "documentation":"Amazon Polly is a web service that makes it easy to synthesize speech from text.
The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.
" }