openapi: 3.0.0 info: version: 2016-06-10 x-release: v4 title: Amazon Polly description:
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.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: "#FFFFFF" termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: polly x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/polly-2016-06-10.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/polly/ servers: - url: http://polly.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Polly multi-region endpoint - url: https://polly.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Polly multi-region endpoint - url: http://polly.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Polly endpoint for China (Beijing) and China (Ningxia) - url: https://polly.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Polly endpoint for China (Beijing) and China (Ningxia) paths: "/v1/lexicons/{LexiconName}": delete: operationId: DeleteLexicon description: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.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteLexiconOutput" "480": description: LexiconNotFoundException content: application/json: schema: $ref: "#/components/schemas/LexiconNotFoundException" "481": description: ServiceFailureException content: application/json: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: LexiconName in: path required: true description: The name of the lexicon to delete. Must be an existing lexicon in the region. schema: type: string pattern: "[0-9A-Za-z]{1,20}" summary: Amazon Polly Delete Lexicon x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GetLexicon description: Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetLexiconOutput" "480": description: LexiconNotFoundException content: application/json: schema: $ref: "#/components/schemas/LexiconNotFoundException" "481": description: ServiceFailureException content: application/json: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: LexiconName in: path required: true description: Name of the lexicon. schema: type: string pattern: "[0-9A-Za-z]{1,20}" summary: Amazon Polly Get Lexicon x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: PutLexicon description: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.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutLexiconOutput" "480": description: InvalidLexiconException content: application/json: schema: $ref: "#/components/schemas/InvalidLexiconException" "481": description: UnsupportedPlsAlphabetException content: application/json: schema: $ref: "#/components/schemas/UnsupportedPlsAlphabetException" "482": description: UnsupportedPlsLanguageException content: application/json: schema: $ref: "#/components/schemas/UnsupportedPlsLanguageException" "483": description: LexiconSizeExceededException content: application/json: schema: $ref: "#/components/schemas/LexiconSizeExceededException" "484": description: MaxLexemeLengthExceededException content: application/json: schema: $ref: "#/components/schemas/MaxLexemeLengthExceededException" "485": description: MaxLexiconsNumberExceededException content: application/json: schema: $ref: "#/components/schemas/MaxLexiconsNumberExceededException" "486": description: ServiceFailureException content: application/json: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: LexiconName in: path required: true description: "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. " schema: type: string pattern: "[0-9A-Za-z]{1,20}" requestBody: required: true content: application/json: schema: type: object required: - Content properties: Content: description: Content of the PLS lexicon as string data. type: string format: password summary: Amazon Polly Put Lexicon x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/voices: get: operationId: DescribeVoices description: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.
standard or neural) used by Amazon Polly when processing input text for speech synthesis. "
schema:
type: string
enum:
- standard
- neural
- name: LanguageCode
in: query
required: false
description: " 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. "
schema:
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
- name: IncludeAdditionalLanguageCodes
in: query
required: false
description: 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.
schema:
type: boolean
- name: NextToken
in: query
required: false
description: An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.
schema:
type: string
minLength: 0
maxLength: 4096
summary: Amazon Polly Describe Voices
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/v1/synthesisTasks/{TaskId}":
get:
operationId: GetSpeechSynthesisTask
description: 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.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetSpeechSynthesisTaskOutput"
"480":
description: InvalidTaskIdException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidTaskIdException"
"481":
description: ServiceFailureException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceFailureException"
"482":
description: SynthesisTaskNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/SynthesisTaskNotFoundException"
parameters:
- name: TaskId
in: path
required: true
description: The Amazon Polly generated identifier for a speech synthesis task.
schema:
type: string
pattern: ^[a-zA-Z0-9_-]{1,100}$
summary: Amazon Polly Get Speech Synthesis Task
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/v1/lexicons:
get:
operationId: ListLexicons
description: Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListLexiconsOutput"
"480":
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidNextTokenException"
"481":
description: ServiceFailureException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceFailureException"
parameters:
- name: NextToken
in: query
required: false
description: An opaque pagination token returned from previous ListLexicons operation. If present, indicates where to continue the list of lexicons.
schema:
type: string
minLength: 0
maxLength: 4096
summary: Amazon Polly List Lexicons
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/v1/synthesisTasks:
get:
operationId: ListSpeechSynthesisTasks
description: 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.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListSpeechSynthesisTasksOutput"
"480":
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidNextTokenException"
"481":
description: ServiceFailureException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceFailureException"
parameters:
- name: MaxResults
in: query
required: false
description: Maximum number of speech synthesis tasks returned in a List operation.
schema:
type: integer
minimum: 1
maximum: 100
- name: NextToken
in: query
required: false
description: "The pagination token to use in the next request to continue the listing of speech synthesis tasks. "
schema:
type: string
minLength: 0
maxLength: 4096
- name: Status
in: query
required: false
description: Status of the speech synthesis tasks returned in a List operation
schema:
type: string
enum:
- scheduled
- inProgress
- completed
- failed
summary: Amazon Polly List Speech Synthesis Tasks
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
operationId: StartSpeechSynthesisTask
description: 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.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/StartSpeechSynthesisTaskOutput"
"480":
description: TextLengthExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/TextLengthExceededException"
"481":
description: InvalidS3BucketException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidS3BucketException"
"482":
description: InvalidS3KeyException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidS3KeyException"
"483":
description: InvalidSampleRateException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidSampleRateException"
"484":
description: InvalidSnsTopicArnException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidSnsTopicArnException"
"485":
description: InvalidSsmlException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidSsmlException"
"486":
description: EngineNotSupportedException
content:
application/json:
schema:
$ref: "#/components/schemas/EngineNotSupportedException"
"487":
description: LexiconNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/LexiconNotFoundException"
"488":
description: ServiceFailureException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceFailureException"
"489":
description: MarksNotSupportedForFormatException
content:
application/json:
schema:
$ref: "#/components/schemas/MarksNotSupportedForFormatException"
"490":
description: SsmlMarksNotSupportedForTextTypeException
content:
application/json:
schema:
$ref: "#/components/schemas/SsmlMarksNotSupportedForTextTypeException"
"491":
description: LanguageNotSupportedException
content:
application/json:
schema:
$ref: "#/components/schemas/LanguageNotSupportedException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- OutputFormat
- OutputS3BucketName
- Text
- VoiceId
properties:
Engine:
description: Specifies the engine (standard or neural) 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.
type: string
enum:
- standard
- neural
LanguageCode:
description: 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.
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".
Valid values for pcm are "8000" and "16000" The default value is "16000".
type: string SnsTopicArn: description: ARN for the SNS topic optionally used for providing status notification for a speech synthesis task. type: string pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0-9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,256}$ SpeechMarkTypes: description: The type of speech marks returned for the input text. type: array items: $ref: "#/components/schemas/SpeechMarkType" maxItems: 4 Text: description: "The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text. " type: string TextType: description: "Specifies whether the input text is plain text or SSML. The default value is plain text. " type: string enum: - ssml - text VoiceId: description: "Voice ID to use for the synthesis. " 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 summary: Amazon Polly Start Speech Synthesis Task x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/speech: post: operationId: SynthesizeSpeech description: 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. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/SynthesizeSpeechOutput" "480": description: TextLengthExceededException content: application/json: schema: $ref: "#/components/schemas/TextLengthExceededException" "481": description: InvalidSampleRateException content: application/json: schema: $ref: "#/components/schemas/InvalidSampleRateException" "482": description: InvalidSsmlException content: application/json: schema: $ref: "#/components/schemas/InvalidSsmlException" "483": description: LexiconNotFoundException content: application/json: schema: $ref: "#/components/schemas/LexiconNotFoundException" "484": description: ServiceFailureException content: application/json: schema: $ref: "#/components/schemas/ServiceFailureException" "485": description: MarksNotSupportedForFormatException content: application/json: schema: $ref: "#/components/schemas/MarksNotSupportedForFormatException" "486": description: SsmlMarksNotSupportedForTextTypeException content: application/json: schema: $ref: "#/components/schemas/SsmlMarksNotSupportedForTextTypeException" "487": description: LanguageNotSupportedException content: application/json: schema: $ref: "#/components/schemas/LanguageNotSupportedException" "488": description: EngineNotSupportedException content: application/json: schema: $ref: "#/components/schemas/EngineNotSupportedException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - OutputFormat - Text - VoiceId properties: Engine: description: 'Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon
Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available
Voices.
NTTS-only voices
When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine
is not specified, or is set to standard, this will result in an error.
Type: String
Valid Values: standard | neural
Required: Yes
Standard voices
For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set
to standard and an NTTS-only voice is selected, this will result in an error.
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.
The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, 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.
type: string enum: - json - mp3 - ogg_vorbis - pcm SampleRate: description: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".
Valid values for pcm are "8000" and "16000" The default value is "16000".
type: string SpeechMarkTypes: description: The type of speech marks returned for the input text. type: array items: $ref: "#/components/schemas/SpeechMarkType" maxItems: 4 Text: description: " Input text to synthesize. If you specifyssml as the TextType, follow the SSML format for the input text. "
type: string
TextType:
description: ' Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using
SSML.'
type: string
enum:
- ssml
- text
VoiceId:
description: ' Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices
operation. '
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
summary: Amazon Polly Synthesize Speech
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
schemas:
DeleteLexiconOutput:
type: object
example: {}
properties: {}
LexiconNotFoundException: {}
ServiceFailureException: {}
DescribeVoicesOutput:
type: object
example:
Voices:
- Gender: Female
Id: Emma
LanguageCode: en-GB
LanguageName: British English
Name: Emma
- Gender: Male
Id: Brian
LanguageCode: en-GB
LanguageName: British English
Name: Brian
- Gender: Female
Id: Amy
LanguageCode: en-GB
LanguageName: British English
Name: Amy
properties:
Voices:
allOf:
- $ref: "#/components/schemas/VoiceList"
- description: A list of voices with their properties.
NextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: The pagination token to use in the next request to continue the listing of voices. NextToken is returned only if the response is truncated.
InvalidNextTokenException: {}
GetLexiconOutput:
type: object
example:
Lexicon:
Content: "\r\nNextToken is returned only if the response is truncated.
ListSpeechSynthesisTasksOutput:
type: object
properties:
NextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.
SynthesisTasks:
allOf:
- $ref: "#/components/schemas/SynthesisTasks"
- description: 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.
PutLexiconOutput:
type: object
example: {}
properties: {}
InvalidLexiconException: {}
UnsupportedPlsAlphabetException: {}
UnsupportedPlsLanguageException: {}
LexiconSizeExceededException: {}
MaxLexemeLengthExceededException: {}
MaxLexiconsNumberExceededException: {}
StartSpeechSynthesisTaskOutput:
type: object
properties:
SynthesisTask:
allOf:
- $ref: "#/components/schemas/SynthesisTask"
- description: SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.
LexiconName:
type: string
pattern: "[0-9A-Za-z]{1,20}"
SpeechMarkType:
type: string
enum:
- sentence
- ssml
- viseme
- word
TextLengthExceededException: {}
InvalidS3BucketException: {}
InvalidS3KeyException: {}
InvalidSampleRateException: {}
InvalidSnsTopicArnException: {}
InvalidSsmlException: {}
EngineNotSupportedException: {}
MarksNotSupportedForFormatException: {}
SsmlMarksNotSupportedForTextTypeException: {}
LanguageNotSupportedException: {}
SynthesizeSpeechOutput:
type: object
example:
AudioStream: TEXT
ContentType: audio/mpeg
RequestCharacters: 37
properties:
AudioStream:
allOf:
- $ref: "#/components/schemas/AudioStream"
- description: " Stream containing the synthesized speech. "
Alphabet:
type: string
AudioStream:
type: string
ContentType:
type: string
DateTime:
type: string
format: date-time
DeleteLexiconInput:
type: object
title: DeleteLexiconInput
properties: {}
Engine:
type: string
enum:
- standard
- neural
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
IncludeAdditionalLanguageCodes:
type: boolean
NextToken:
type: string
minLength: 0
maxLength: 4096
DescribeVoicesInput:
type: object
title: DescribeVoicesInput
properties: {}
VoiceList:
type: array
items:
$ref: "#/components/schemas/Voice"
EngineList:
type: array
items:
$ref: "#/components/schemas/Engine"
Gender:
type: string
enum:
- Female
- Male
GetLexiconInput:
type: object
title: GetLexiconInput
properties: {}
Lexicon:
type: object
properties:
Content:
allOf:
- $ref: "#/components/schemas/LexiconContent"
- description: Lexicon content in string format. The content of a lexicon must be in PLS format.
Name:
allOf:
- $ref: "#/components/schemas/LexiconName"
- description: Name of the lexicon.
description: Provides lexicon name and lexicon content in string format. For more information, see Pronunciation Lexicon Specification
(PLS) Version 1.0.
LexiconAttributes:
type: object
properties:
Alphabet:
allOf:
- $ref: "#/components/schemas/Alphabet"
- description: Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.
LanguageCode:
allOf:
- $ref: "#/components/schemas/LanguageCode"
- description: 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:
allOf:
- $ref: "#/components/schemas/LastModified"
- description: Date lexicon was last modified (a timestamp value).
LexiconArn:
allOf:
- $ref: "#/components/schemas/LexiconArn"
- description: Amazon Resource Name (ARN) of the lexicon.
LexemesCount:
allOf:
- $ref: "#/components/schemas/LexemesCount"
- description: Number of lexemes in the lexicon.
Size:
allOf:
- $ref: "#/components/schemas/Size"
- description: Total size of the lexicon, in characters.
description: Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons.
TaskId:
type: string
pattern: ^[a-zA-Z0-9_-]{1,100}$
GetSpeechSynthesisTaskInput:
type: object
title: GetSpeechSynthesisTaskInput
properties: {}
SynthesisTask:
type: object
properties:
Engine:
allOf:
- $ref: "#/components/schemas/Engine"
- description: Specifies the engine (standard or neural) 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.
TaskId:
allOf:
- $ref: "#/components/schemas/TaskId"
- description: The Amazon Polly generated identifier for a speech synthesis task.
TaskStatus:
allOf:
- $ref: "#/components/schemas/TaskStatus"
- description: Current status of the individual speech synthesis task.
TaskStatusReason:
allOf:
- $ref: "#/components/schemas/TaskStatusReason"
- description: Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
OutputUri:
allOf:
- $ref: "#/components/schemas/OutputUri"
- description: Pathway for the output speech file.
CreationTime:
allOf:
- $ref: "#/components/schemas/DateTime"
- description: Timestamp for the time the synthesis task was started.
RequestCharacters:
allOf:
- $ref: "#/components/schemas/RequestCharacters"
- description: Number of billable characters synthesized.
SnsTopicArn:
allOf:
- $ref: "#/components/schemas/SnsTopicArn"
- description: ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
LexiconNames:
allOf:
- $ref: "#/components/schemas/LexiconNameList"
- description: "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:
allOf:
- $ref: "#/components/schemas/OutputFormat"
- description: "The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. "
SampleRate:
allOf:
- $ref: "#/components/schemas/SampleRate"
- description: 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".
Valid values for pcm are "8000" and "16000" The default value is "16000".
SpeechMarkTypes: allOf: - $ref: "#/components/schemas/SpeechMarkTypeList" - description: The type of speech marks returned for the input text. TextType: allOf: - $ref: "#/components/schemas/TextType" - description: "Specifies whether the input text is plain text or SSML. The default value is plain text. " VoiceId: allOf: - $ref: "#/components/schemas/VoiceId" - description: "Voice ID to use for the synthesis. " LanguageCode: allOf: - $ref: "#/components/schemas/LanguageCode" - description: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.
standard or neural) 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.
LanguageCode:
allOf:
- $ref: "#/components/schemas/LanguageCode"
- description: 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.
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".
Valid values for pcm are "8000" and "16000" The default value is "16000".
SnsTopicArn: allOf: - $ref: "#/components/schemas/SnsTopicArn" - description: ARN for the SNS topic optionally used for providing status notification for a speech synthesis task. SpeechMarkTypes: allOf: - $ref: "#/components/schemas/SpeechMarkTypeList" - description: The type of speech marks returned for the input text. Text: allOf: - $ref: "#/components/schemas/Text" - description: "The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text. " TextType: allOf: - $ref: "#/components/schemas/TextType" - description: "Specifies whether the input text is plain text or SSML. The default value is plain text. " VoiceId: allOf: - $ref: "#/components/schemas/VoiceId" - description: "Voice ID to use for the synthesis. " TaskStatusReason: type: string SynthesizeSpeechInput: type: object required: - OutputFormat - Text - VoiceId title: SynthesizeSpeechInput properties: Engine: allOf: - $ref: "#/components/schemas/Engine" - description: 'Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly
voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.
NTTS-only voices
When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or
is set to standard, this will result in an error.
Type: String
Valid Values: standard | neural
Required: Yes
Standard voices
For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and
an NTTS-only voice is selected, this will result in an error.
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.
The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, 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: allOf: - $ref: "#/components/schemas/SampleRate" - description: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".
Valid values for pcm are "8000" and "16000" The default value is "16000".
SpeechMarkTypes: allOf: - $ref: "#/components/schemas/SpeechMarkTypeList" - description: The type of speech marks returned for the input text. Text: allOf: - $ref: "#/components/schemas/Text" - description: " Input text to synthesize. If you specifyssml as the TextType, follow the SSML format for the input text. "
TextType:
allOf:
- $ref: "#/components/schemas/TextType"
- description: ' Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using
SSML.'
VoiceId:
allOf:
- $ref: "#/components/schemas/VoiceId"
- description: ' Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices
operation. '
VoiceName:
type: string
Voice:
type: object
properties:
Gender:
allOf:
- $ref: "#/components/schemas/Gender"
- description: Gender of the voice.
Id:
allOf:
- $ref: "#/components/schemas/VoiceId"
- description: Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
LanguageCode:
allOf:
- $ref: "#/components/schemas/LanguageCode"
- description: Language code of the voice.
LanguageName:
allOf:
- $ref: "#/components/schemas/LanguageName"
- description: Human readable name of the language in English.
Name:
allOf:
- $ref: "#/components/schemas/VoiceName"
- description: Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
AdditionalLanguageCodes:
allOf:
- $ref: "#/components/schemas/LanguageCodeList"
- description: 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.
standard or neural) that are supported by a given voice.
description: Description of the voice.
security:
- hmac: []