UNPKG

29 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {PollyCustomizations} from '../lib/services/polly';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7import {Presigner as presigner} from '../lib/polly/presigner';
8import {Readable} from 'stream';
9interface Blob {}
10declare class Polly extends PollyCustomizations {
11 /**
12 * Constructs a service object. This object has one method for each API operation.
13 */
14 constructor(options?: Polly.Types.ClientConfiguration)
15 config: Config & Polly.Types.ClientConfiguration;
16 /**
17 * Deletes the specified pronunciation lexicon stored in an AWS 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.
18 */
19 deleteLexicon(params: Polly.Types.DeleteLexiconInput, callback?: (err: AWSError, data: Polly.Types.DeleteLexiconOutput) => void): Request<Polly.Types.DeleteLexiconOutput, AWSError>;
20 /**
21 * Deletes the specified pronunciation lexicon stored in an AWS 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.
22 */
23 deleteLexicon(callback?: (err: AWSError, data: Polly.Types.DeleteLexiconOutput) => void): Request<Polly.Types.DeleteLexiconOutput, AWSError>;
24 /**
25 * 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.
26 */
27 describeVoices(params: Polly.Types.DescribeVoicesInput, callback?: (err: AWSError, data: Polly.Types.DescribeVoicesOutput) => void): Request<Polly.Types.DescribeVoicesOutput, AWSError>;
28 /**
29 * 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.
30 */
31 describeVoices(callback?: (err: AWSError, data: Polly.Types.DescribeVoicesOutput) => void): Request<Polly.Types.DescribeVoicesOutput, AWSError>;
32 /**
33 * Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.
34 */
35 getLexicon(params: Polly.Types.GetLexiconInput, callback?: (err: AWSError, data: Polly.Types.GetLexiconOutput) => void): Request<Polly.Types.GetLexiconOutput, AWSError>;
36 /**
37 * Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.
38 */
39 getLexicon(callback?: (err: AWSError, data: Polly.Types.GetLexiconOutput) => void): Request<Polly.Types.GetLexiconOutput, AWSError>;
40 /**
41 * 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.
42 */
43 getSpeechSynthesisTask(params: Polly.Types.GetSpeechSynthesisTaskInput, callback?: (err: AWSError, data: Polly.Types.GetSpeechSynthesisTaskOutput) => void): Request<Polly.Types.GetSpeechSynthesisTaskOutput, AWSError>;
44 /**
45 * 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.
46 */
47 getSpeechSynthesisTask(callback?: (err: AWSError, data: Polly.Types.GetSpeechSynthesisTaskOutput) => void): Request<Polly.Types.GetSpeechSynthesisTaskOutput, AWSError>;
48 /**
49 * Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.
50 */
51 listLexicons(params: Polly.Types.ListLexiconsInput, callback?: (err: AWSError, data: Polly.Types.ListLexiconsOutput) => void): Request<Polly.Types.ListLexiconsOutput, AWSError>;
52 /**
53 * Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.
54 */
55 listLexicons(callback?: (err: AWSError, data: Polly.Types.ListLexiconsOutput) => void): Request<Polly.Types.ListLexiconsOutput, AWSError>;
56 /**
57 * 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.
58 */
59 listSpeechSynthesisTasks(params: Polly.Types.ListSpeechSynthesisTasksInput, callback?: (err: AWSError, data: Polly.Types.ListSpeechSynthesisTasksOutput) => void): Request<Polly.Types.ListSpeechSynthesisTasksOutput, AWSError>;
60 /**
61 * 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.
62 */
63 listSpeechSynthesisTasks(callback?: (err: AWSError, data: Polly.Types.ListSpeechSynthesisTasksOutput) => void): Request<Polly.Types.ListSpeechSynthesisTasksOutput, AWSError>;
64 /**
65 * Stores a pronunciation lexicon in an AWS 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.
66 */
67 putLexicon(params: Polly.Types.PutLexiconInput, callback?: (err: AWSError, data: Polly.Types.PutLexiconOutput) => void): Request<Polly.Types.PutLexiconOutput, AWSError>;
68 /**
69 * Stores a pronunciation lexicon in an AWS 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.
70 */
71 putLexicon(callback?: (err: AWSError, data: Polly.Types.PutLexiconOutput) => void): Request<Polly.Types.PutLexiconOutput, AWSError>;
72 /**
73 * 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.
74 */
75 startSpeechSynthesisTask(params: Polly.Types.StartSpeechSynthesisTaskInput, callback?: (err: AWSError, data: Polly.Types.StartSpeechSynthesisTaskOutput) => void): Request<Polly.Types.StartSpeechSynthesisTaskOutput, AWSError>;
76 /**
77 * 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.
78 */
79 startSpeechSynthesisTask(callback?: (err: AWSError, data: Polly.Types.StartSpeechSynthesisTaskOutput) => void): Request<Polly.Types.StartSpeechSynthesisTaskOutput, AWSError>;
80 /**
81 * 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.
82 */
83 synthesizeSpeech(params: Polly.Types.SynthesizeSpeechInput, callback?: (err: AWSError, data: Polly.Types.SynthesizeSpeechOutput) => void): Request<Polly.Types.SynthesizeSpeechOutput, AWSError>;
84 /**
85 * 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.
86 */
87 synthesizeSpeech(callback?: (err: AWSError, data: Polly.Types.SynthesizeSpeechOutput) => void): Request<Polly.Types.SynthesizeSpeechOutput, AWSError>;
88}
89declare namespace Polly {
90 export import Presigner = presigner;
91}
92declare namespace Polly {
93 export type Alphabet = string;
94 export type AudioStream = Buffer|Uint8Array|Blob|string|Readable;
95 export type ContentType = string;
96 export type DateTime = Date;
97 export interface DeleteLexiconInput {
98 /**
99 * The name of the lexicon to delete. Must be an existing lexicon in the region.
100 */
101 Name: LexiconName;
102 }
103 export interface DeleteLexiconOutput {
104 }
105 export interface DescribeVoicesInput {
106 /**
107 * Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.
108 */
109 Engine?: Engine;
110 /**
111 * 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.
112 */
113 LanguageCode?: LanguageCode;
114 /**
115 * 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.
116 */
117 IncludeAdditionalLanguageCodes?: IncludeAdditionalLanguageCodes;
118 /**
119 * An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.
120 */
121 NextToken?: NextToken;
122 }
123 export interface DescribeVoicesOutput {
124 /**
125 * A list of voices with their properties.
126 */
127 Voices?: VoiceList;
128 /**
129 * The pagination token to use in the next request to continue the listing of voices. NextToken is returned only if the response is truncated.
130 */
131 NextToken?: NextToken;
132 }
133 export type Engine = "standard"|"neural"|string;
134 export type EngineList = Engine[];
135 export type Gender = "Female"|"Male"|string;
136 export interface GetLexiconInput {
137 /**
138 * Name of the lexicon.
139 */
140 Name: LexiconName;
141 }
142 export interface GetLexiconOutput {
143 /**
144 * Lexicon object that provides name and the string content of the lexicon.
145 */
146 Lexicon?: Lexicon;
147 /**
148 * 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.
149 */
150 LexiconAttributes?: LexiconAttributes;
151 }
152 export interface GetSpeechSynthesisTaskInput {
153 /**
154 * The Amazon Polly generated identifier for a speech synthesis task.
155 */
156 TaskId: TaskId;
157 }
158 export interface GetSpeechSynthesisTaskOutput {
159 /**
160 * SynthesisTask object that provides information from the requested task, including output format, creation time, task status, and so on.
161 */
162 SynthesisTask?: SynthesisTask;
163 }
164 export type IncludeAdditionalLanguageCodes = boolean;
165 export type LanguageCode = "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"|string;
166 export type LanguageCodeList = LanguageCode[];
167 export type LanguageName = string;
168 export type LastModified = Date;
169 export type LexemesCount = number;
170 export interface Lexicon {
171 /**
172 * Lexicon content in string format. The content of a lexicon must be in PLS format.
173 */
174 Content?: LexiconContent;
175 /**
176 * Name of the lexicon.
177 */
178 Name?: LexiconName;
179 }
180 export type LexiconArn = string;
181 export interface LexiconAttributes {
182 /**
183 * Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.
184 */
185 Alphabet?: Alphabet;
186 /**
187 * 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.
188 */
189 LanguageCode?: LanguageCode;
190 /**
191 * Date lexicon was last modified (a timestamp value).
192 */
193 LastModified?: LastModified;
194 /**
195 * Amazon Resource Name (ARN) of the lexicon.
196 */
197 LexiconArn?: LexiconArn;
198 /**
199 * Number of lexemes in the lexicon.
200 */
201 LexemesCount?: LexemesCount;
202 /**
203 * Total size of the lexicon, in characters.
204 */
205 Size?: Size;
206 }
207 export type LexiconContent = string;
208 export interface LexiconDescription {
209 /**
210 * Name of the lexicon.
211 */
212 Name?: LexiconName;
213 /**
214 * Provides lexicon metadata.
215 */
216 Attributes?: LexiconAttributes;
217 }
218 export type LexiconDescriptionList = LexiconDescription[];
219 export type LexiconName = string;
220 export type LexiconNameList = LexiconName[];
221 export interface ListLexiconsInput {
222 /**
223 * An opaque pagination token returned from previous ListLexicons operation. If present, indicates where to continue the list of lexicons.
224 */
225 NextToken?: NextToken;
226 }
227 export interface ListLexiconsOutput {
228 /**
229 * A list of lexicon names and attributes.
230 */
231 Lexicons?: LexiconDescriptionList;
232 /**
233 * The pagination token to use in the next request to continue the listing of lexicons. NextToken is returned only if the response is truncated.
234 */
235 NextToken?: NextToken;
236 }
237 export interface ListSpeechSynthesisTasksInput {
238 /**
239 * Maximum number of speech synthesis tasks returned in a List operation.
240 */
241 MaxResults?: MaxResults;
242 /**
243 * The pagination token to use in the next request to continue the listing of speech synthesis tasks.
244 */
245 NextToken?: NextToken;
246 /**
247 * Status of the speech synthesis tasks returned in a List operation
248 */
249 Status?: TaskStatus;
250 }
251 export interface ListSpeechSynthesisTasksOutput {
252 /**
253 * An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.
254 */
255 NextToken?: NextToken;
256 /**
257 * 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.
258 */
259 SynthesisTasks?: SynthesisTasks;
260 }
261 export type MaxResults = number;
262 export type NextToken = string;
263 export type OutputFormat = "json"|"mp3"|"ogg_vorbis"|"pcm"|string;
264 export type OutputS3BucketName = string;
265 export type OutputS3KeyPrefix = string;
266 export type OutputUri = string;
267 export interface PutLexiconInput {
268 /**
269 * 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.
270 */
271 Name: LexiconName;
272 /**
273 * Content of the PLS lexicon as string data.
274 */
275 Content: LexiconContent;
276 }
277 export interface PutLexiconOutput {
278 }
279 export type RequestCharacters = number;
280 export type SampleRate = string;
281 export type Size = number;
282 export type SnsTopicArn = string;
283 export type SpeechMarkType = "sentence"|"ssml"|"viseme"|"word"|string;
284 export type SpeechMarkTypeList = SpeechMarkType[];
285 export interface StartSpeechSynthesisTaskInput {
286 /**
287 * 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.
288 */
289 Engine?: Engine;
290 /**
291 * 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 will use 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.
292 */
293 LanguageCode?: LanguageCode;
294 /**
295 * 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.
296 */
297 LexiconNames?: LexiconNameList;
298 /**
299 * 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.
300 */
301 OutputFormat: OutputFormat;
302 /**
303 * Amazon S3 bucket name to which the output file will be saved.
304 */
305 OutputS3BucketName: OutputS3BucketName;
306 /**
307 * The Amazon S3 key prefix for the output speech file.
308 */
309 OutputS3KeyPrefix?: OutputS3KeyPrefix;
310 /**
311 * 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".
312 */
313 SampleRate?: SampleRate;
314 /**
315 * ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
316 */
317 SnsTopicArn?: SnsTopicArn;
318 /**
319 * The type of speech marks returned for the input text.
320 */
321 SpeechMarkTypes?: SpeechMarkTypeList;
322 /**
323 * The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
324 */
325 Text: Text;
326 /**
327 * Specifies whether the input text is plain text or SSML. The default value is plain text.
328 */
329 TextType?: TextType;
330 /**
331 * Voice ID to use for the synthesis.
332 */
333 VoiceId: VoiceId;
334 }
335 export interface StartSpeechSynthesisTaskOutput {
336 /**
337 * SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.
338 */
339 SynthesisTask?: SynthesisTask;
340 }
341 export interface SynthesisTask {
342 /**
343 * 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.
344 */
345 Engine?: Engine;
346 /**
347 * The Amazon Polly generated identifier for a speech synthesis task.
348 */
349 TaskId?: TaskId;
350 /**
351 * Current status of the individual speech synthesis task.
352 */
353 TaskStatus?: TaskStatus;
354 /**
355 * Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
356 */
357 TaskStatusReason?: TaskStatusReason;
358 /**
359 * Pathway for the output speech file.
360 */
361 OutputUri?: OutputUri;
362 /**
363 * Timestamp for the time the synthesis task was started.
364 */
365 CreationTime?: DateTime;
366 /**
367 * Number of billable characters synthesized.
368 */
369 RequestCharacters?: RequestCharacters;
370 /**
371 * ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
372 */
373 SnsTopicArn?: SnsTopicArn;
374 /**
375 * 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.
376 */
377 LexiconNames?: LexiconNameList;
378 /**
379 * 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.
380 */
381 OutputFormat?: OutputFormat;
382 /**
383 * 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".
384 */
385 SampleRate?: SampleRate;
386 /**
387 * The type of speech marks returned for the input text.
388 */
389 SpeechMarkTypes?: SpeechMarkTypeList;
390 /**
391 * Specifies whether the input text is plain text or SSML. The default value is plain text.
392 */
393 TextType?: TextType;
394 /**
395 * Voice ID to use for the synthesis.
396 */
397 VoiceId?: VoiceId;
398 /**
399 * 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 will use 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.
400 */
401 LanguageCode?: LanguageCode;
402 }
403 export type SynthesisTasks = SynthesisTask[];
404 export interface SynthesizeSpeechInput {
405 /**
406 * 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.
407 */
408 Engine?: Engine;
409 /**
410 * 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 will use 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.
411 */
412 LanguageCode?: LanguageCode;
413 /**
414 * 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.
415 */
416 LexiconNames?: LexiconNameList;
417 /**
418 * 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.
419 */
420 OutputFormat: OutputFormat;
421 /**
422 * 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".
423 */
424 SampleRate?: SampleRate;
425 /**
426 * The type of speech marks returned for the input text.
427 */
428 SpeechMarkTypes?: SpeechMarkTypeList;
429 /**
430 * Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
431 */
432 Text: Text;
433 /**
434 * Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.
435 */
436 TextType?: TextType;
437 /**
438 * Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
439 */
440 VoiceId: VoiceId;
441 }
442 export interface SynthesizeSpeechOutput {
443 /**
444 * Stream containing the synthesized speech.
445 */
446 AudioStream?: AudioStream;
447 /**
448 * 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 pcm as the OutputFormat, the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format. If you request json as the OutputFormat, the ContentType returned is audio/json.
449 */
450 ContentType?: ContentType;
451 /**
452 * Number of characters synthesized.
453 */
454 RequestCharacters?: RequestCharacters;
455 }
456 export type TaskId = string;
457 export type TaskStatus = "scheduled"|"inProgress"|"completed"|"failed"|string;
458 export type TaskStatusReason = string;
459 export type Text = string;
460 export type TextType = "ssml"|"text"|string;
461 export interface Voice {
462 /**
463 * Gender of the voice.
464 */
465 Gender?: Gender;
466 /**
467 * Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
468 */
469 Id?: VoiceId;
470 /**
471 * Language code of the voice.
472 */
473 LanguageCode?: LanguageCode;
474 /**
475 * Human readable name of the language in English.
476 */
477 LanguageName?: LanguageName;
478 /**
479 * Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
480 */
481 Name?: VoiceName;
482 /**
483 * 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.
484 */
485 AdditionalLanguageCodes?: LanguageCodeList;
486 /**
487 * Specifies which engines (standard or neural) that are supported by a given voice.
488 */
489 SupportedEngines?: EngineList;
490 }
491 export type VoiceId = "Aditi"|"Amy"|"Astrid"|"Bianca"|"Brian"|"Camila"|"Carla"|"Carmen"|"Celine"|"Chantal"|"Conchita"|"Cristiano"|"Dora"|"Emma"|"Enrique"|"Ewa"|"Filiz"|"Geraint"|"Giorgio"|"Gwyneth"|"Hans"|"Ines"|"Ivy"|"Jacek"|"Jan"|"Joanna"|"Joey"|"Justin"|"Karl"|"Kendra"|"Kimberly"|"Lea"|"Liv"|"Lotte"|"Lucia"|"Lupe"|"Mads"|"Maja"|"Marlene"|"Mathieu"|"Matthew"|"Maxim"|"Mia"|"Miguel"|"Mizuki"|"Naja"|"Nicole"|"Penelope"|"Raveena"|"Ricardo"|"Ruben"|"Russell"|"Salli"|"Seoyeon"|"Takumi"|"Tatyana"|"Vicki"|"Vitoria"|"Zeina"|"Zhiyu"|string;
492 export type VoiceList = Voice[];
493 export type VoiceName = string;
494 /**
495 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
496 */
497 export type apiVersion = "2016-06-10"|"latest"|string;
498 export interface ClientApiVersions {
499 /**
500 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
501 */
502 apiVersion?: apiVersion;
503 }
504 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
505 /**
506 * Contains interfaces for use with the Polly client.
507 */
508 export import Types = Polly;
509}
510export = Polly;