@aws-sdk/client-polly 3.36.0 → 3.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/Polly.js +0 -8
  3. package/dist-cjs/PollyClient.js +0 -13
  4. package/dist-cjs/commands/DeleteLexiconCommand.js +0 -27
  5. package/dist-cjs/commands/DescribeVoicesCommand.js +0 -42
  6. package/dist-cjs/commands/GetLexiconCommand.js +0 -25
  7. package/dist-cjs/commands/GetSpeechSynthesisTaskCommand.js +0 -27
  8. package/dist-cjs/commands/ListLexiconsCommand.js +0 -24
  9. package/dist-cjs/commands/ListSpeechSynthesisTasksCommand.js +0 -26
  10. package/dist-cjs/commands/PutLexiconCommand.js +0 -29
  11. package/dist-cjs/commands/StartSpeechSynthesisTaskCommand.js +0 -33
  12. package/dist-cjs/commands/SynthesizeSpeechCommand.js +0 -28
  13. package/dist-cjs/commands/index.js +12 -0
  14. package/dist-cjs/endpoints.js +6 -1
  15. package/dist-cjs/index.js +4 -13
  16. package/dist-cjs/models/models_0.js +0 -132
  17. package/dist-cjs/pagination/ListSpeechSynthesisTasksPaginator.js +0 -10
  18. package/dist-cjs/pagination/index.js +5 -0
  19. package/dist-cjs/protocols/Aws_restJson1.js +0 -5
  20. package/dist-cjs/runtimeConfig.browser.js +1 -5
  21. package/dist-cjs/runtimeConfig.js +1 -5
  22. package/dist-cjs/runtimeConfig.native.js +0 -3
  23. package/dist-cjs/runtimeConfig.shared.js +0 -3
  24. package/dist-es/commands/index.js +9 -0
  25. package/dist-es/endpoints.js +6 -1
  26. package/dist-es/index.js +4 -13
  27. package/dist-es/pagination/index.js +2 -0
  28. package/dist-types/commands/index.d.ts +9 -0
  29. package/dist-types/index.d.ts +4 -13
  30. package/dist-types/pagination/index.d.ts +2 -0
  31. package/dist-types/ts3.4/Polly.d.ts +10 -80
  32. package/dist-types/ts3.4/PollyClient.d.ts +24 -94
  33. package/dist-types/ts3.4/commands/DeleteLexiconCommand.d.ts +2 -23
  34. package/dist-types/ts3.4/commands/DescribeVoicesCommand.d.ts +2 -38
  35. package/dist-types/ts3.4/commands/GetLexiconCommand.d.ts +2 -21
  36. package/dist-types/ts3.4/commands/GetSpeechSynthesisTaskCommand.d.ts +2 -23
  37. package/dist-types/ts3.4/commands/ListLexiconsCommand.d.ts +2 -20
  38. package/dist-types/ts3.4/commands/ListSpeechSynthesisTasksCommand.d.ts +2 -22
  39. package/dist-types/ts3.4/commands/PutLexiconCommand.d.ts +2 -25
  40. package/dist-types/ts3.4/commands/StartSpeechSynthesisTaskCommand.d.ts +2 -29
  41. package/dist-types/ts3.4/commands/SynthesizeSpeechCommand.d.ts +2 -24
  42. package/dist-types/ts3.4/commands/index.d.ts +9 -0
  43. package/dist-types/ts3.4/index.d.ts +4 -13
  44. package/dist-types/ts3.4/models/models_0.d.ts +150 -642
  45. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  46. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  47. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  48. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  49. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  50. package/package.json +32 -32
@@ -1,57 +1,38 @@
1
- /// <reference types="node" />
1
+
2
2
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
3
3
  import { Readable } from "stream";
4
4
  export interface DeleteLexiconInput {
5
- /**
6
- * <p>The name of the lexicon to delete. Must be an existing lexicon in
7
- * the region.</p>
8
- */
5
+
9
6
  Name: string | undefined;
10
7
  }
11
8
  export declare namespace DeleteLexiconInput {
12
- /**
13
- * @internal
14
- */
9
+
15
10
  const filterSensitiveLog: (obj: DeleteLexiconInput) => any;
16
11
  }
17
12
  export interface DeleteLexiconOutput {
18
13
  }
19
14
  export declare namespace DeleteLexiconOutput {
20
- /**
21
- * @internal
22
- */
15
+
23
16
  const filterSensitiveLog: (obj: DeleteLexiconOutput) => any;
24
17
  }
25
- /**
26
- * <p>Amazon Polly can't find the specified lexicon. This could be caused by a
27
- * lexicon that is missing, its name is misspelled or specifying a lexicon
28
- * that is in a different region.</p>
29
- * <p>Verify that the lexicon exists, is in the region (see <a>ListLexicons</a>) and that you spelled its name is spelled
30
- * correctly. Then try again.</p>
31
- */
18
+
32
19
  export interface LexiconNotFoundException extends __SmithyException, $MetadataBearer {
33
20
  name: "LexiconNotFoundException";
34
21
  $fault: "client";
35
22
  message?: string;
36
23
  }
37
24
  export declare namespace LexiconNotFoundException {
38
- /**
39
- * @internal
40
- */
25
+
41
26
  const filterSensitiveLog: (obj: LexiconNotFoundException) => any;
42
27
  }
43
- /**
44
- * <p>An unknown condition has caused a service failure.</p>
45
- */
28
+
46
29
  export interface ServiceFailureException extends __SmithyException, $MetadataBearer {
47
30
  name: "ServiceFailureException";
48
31
  $fault: "server";
49
32
  message?: string;
50
33
  }
51
34
  export declare namespace ServiceFailureException {
52
- /**
53
- * @internal
54
- */
35
+
55
36
  const filterSensitiveLog: (obj: ServiceFailureException) => any;
56
37
  }
57
38
  export declare enum Engine {
@@ -60,241 +41,126 @@ export declare enum Engine {
60
41
  }
61
42
  export declare type LanguageCode = "arb" | "cmn-CN" | "cy-GB" | "da-DK" | "de-DE" | "en-AU" | "en-GB" | "en-GB-WLS" | "en-IN" | "en-NZ" | "en-US" | "en-ZA" | "es-ES" | "es-MX" | "es-US" | "fr-CA" | "fr-FR" | "hi-IN" | "is-IS" | "it-IT" | "ja-JP" | "ko-KR" | "nb-NO" | "nl-NL" | "pl-PL" | "pt-BR" | "pt-PT" | "ro-RO" | "ru-RU" | "sv-SE" | "tr-TR";
62
43
  export interface DescribeVoicesInput {
63
- /**
64
- * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
65
- * used by Amazon Polly when processing input text for speech synthesis. </p>
66
- */
44
+
67
45
  Engine?: Engine | string;
68
- /**
69
- * <p> The language identification tag (ISO 639 code for the language
70
- * name-ISO 3166 country code) for filtering the list of voices returned. If
71
- * you don't specify this optional parameter, all available voices are
72
- * returned. </p>
73
- */
46
+
74
47
  LanguageCode?: LanguageCode | string;
75
- /**
76
- * <p>Boolean value indicating whether to return any bilingual voices that
77
- * use the specified language as an additional language. For instance, if you
78
- * request all languages that use US English (es-US), and there is an Italian
79
- * voice that speaks both Italian (it-IT) and US English, that voice will be
80
- * included if you specify <code>yes</code> but not if you specify
81
- * <code>no</code>.</p>
82
- */
48
+
83
49
  IncludeAdditionalLanguageCodes?: boolean;
84
- /**
85
- * <p>An opaque pagination token returned from the previous
86
- * <code>DescribeVoices</code> operation. If present, this indicates where
87
- * to continue the listing.</p>
88
- */
50
+
89
51
  NextToken?: string;
90
52
  }
91
53
  export declare namespace DescribeVoicesInput {
92
- /**
93
- * @internal
94
- */
54
+
95
55
  const filterSensitiveLog: (obj: DescribeVoicesInput) => any;
96
56
  }
97
57
  export declare type Gender = "Female" | "Male";
98
58
  export declare type VoiceId = "Aditi" | "Amy" | "Aria" | "Astrid" | "Ayanda" | "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";
99
- /**
100
- * <p>Description of the voice.</p>
101
- */
59
+
102
60
  export interface Voice {
103
- /**
104
- * <p>Gender of the voice.</p>
105
- */
61
+
106
62
  Gender?: Gender | string;
107
- /**
108
- * <p>Amazon Polly assigned voice ID. This is the ID that you specify when
109
- * calling the <code>SynthesizeSpeech</code> operation.</p>
110
- */
63
+
111
64
  Id?: VoiceId | string;
112
- /**
113
- * <p>Language code of the voice.</p>
114
- */
65
+
115
66
  LanguageCode?: LanguageCode | string;
116
- /**
117
- * <p>Human readable name of the language in English.</p>
118
- */
67
+
119
68
  LanguageName?: string;
120
- /**
121
- * <p>Name of the voice (for example, Salli, Kendra, etc.). This provides
122
- * a human readable voice name that you might display in your
123
- * application.</p>
124
- */
69
+
125
70
  Name?: string;
126
- /**
127
- * <p>Additional codes for languages available for the specified voice in
128
- * addition to its default language. </p>
129
- * <p>For example, the default language for Aditi is Indian English (en-IN)
130
- * because it was first used for that language. Since Aditi is bilingual and
131
- * fluent in both Indian English and Hindi, this parameter would show the
132
- * code <code>hi-IN</code>.</p>
133
- */
71
+
134
72
  AdditionalLanguageCodes?: (LanguageCode | string)[];
135
- /**
136
- * <p>Specifies which engines (<code>standard</code> or <code>neural</code>)
137
- * that are supported by a given voice.</p>
138
- */
73
+
139
74
  SupportedEngines?: (Engine | string)[];
140
75
  }
141
76
  export declare namespace Voice {
142
- /**
143
- * @internal
144
- */
77
+
145
78
  const filterSensitiveLog: (obj: Voice) => any;
146
79
  }
147
80
  export interface DescribeVoicesOutput {
148
- /**
149
- * <p>A list of voices with their properties.</p>
150
- */
81
+
151
82
  Voices?: Voice[];
152
- /**
153
- * <p>The pagination token to use in the next request to continue the
154
- * listing of voices. <code>NextToken</code> is returned only if the response
155
- * is truncated.</p>
156
- */
83
+
157
84
  NextToken?: string;
158
85
  }
159
86
  export declare namespace DescribeVoicesOutput {
160
- /**
161
- * @internal
162
- */
87
+
163
88
  const filterSensitiveLog: (obj: DescribeVoicesOutput) => any;
164
89
  }
165
- /**
166
- * <p>The NextToken is invalid. Verify that it's spelled correctly, and
167
- * then try again.</p>
168
- */
90
+
169
91
  export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
170
92
  name: "InvalidNextTokenException";
171
93
  $fault: "client";
172
94
  message?: string;
173
95
  }
174
96
  export declare namespace InvalidNextTokenException {
175
- /**
176
- * @internal
177
- */
97
+
178
98
  const filterSensitiveLog: (obj: InvalidNextTokenException) => any;
179
99
  }
180
- /**
181
- * <p>This engine is not compatible with the voice that you have designated.
182
- * Choose a new voice that is compatible with the engine or change the engine
183
- * and restart the operation.</p>
184
- */
100
+
185
101
  export interface EngineNotSupportedException extends __SmithyException, $MetadataBearer {
186
102
  name: "EngineNotSupportedException";
187
103
  $fault: "client";
188
104
  message?: string;
189
105
  }
190
106
  export declare namespace EngineNotSupportedException {
191
- /**
192
- * @internal
193
- */
107
+
194
108
  const filterSensitiveLog: (obj: EngineNotSupportedException) => any;
195
109
  }
196
110
  export interface GetLexiconInput {
197
- /**
198
- * <p>Name of the lexicon.</p>
199
- */
111
+
200
112
  Name: string | undefined;
201
113
  }
202
114
  export declare namespace GetLexiconInput {
203
- /**
204
- * @internal
205
- */
115
+
206
116
  const filterSensitiveLog: (obj: GetLexiconInput) => any;
207
117
  }
208
- /**
209
- * <p>Provides lexicon name and lexicon content in string format. For
210
- * more information, see <a href="https://www.w3.org/TR/pronunciation-lexicon/">Pronunciation Lexicon
211
- * Specification (PLS) Version 1.0</a>.</p>
212
- */
118
+
213
119
  export interface Lexicon {
214
- /**
215
- * <p>Lexicon content in string format. The content of a lexicon must be
216
- * in PLS format.</p>
217
- */
120
+
218
121
  Content?: string;
219
- /**
220
- * <p>Name of the lexicon.</p>
221
- */
122
+
222
123
  Name?: string;
223
124
  }
224
125
  export declare namespace Lexicon {
225
- /**
226
- * @internal
227
- */
126
+
228
127
  const filterSensitiveLog: (obj: Lexicon) => any;
229
128
  }
230
- /**
231
- * <p>Contains metadata describing the lexicon such as the number of
232
- * lexemes, language code, and so on. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>.</p>
233
- */
129
+
234
130
  export interface LexiconAttributes {
235
- /**
236
- * <p>Phonetic alphabet used in the lexicon. Valid values are
237
- * <code>ipa</code> and <code>x-sampa</code>.</p>
238
- */
131
+
239
132
  Alphabet?: string;
240
- /**
241
- * <p>Language code that the lexicon applies to. A lexicon with a
242
- * language code such as "en" would be applied to all English languages
243
- * (en-GB, en-US, en-AUS, en-WLS, and so on.</p>
244
- */
133
+
245
134
  LanguageCode?: LanguageCode | string;
246
- /**
247
- * <p>Date lexicon was last modified (a timestamp value).</p>
248
- */
135
+
249
136
  LastModified?: Date;
250
- /**
251
- * <p>Amazon Resource Name (ARN) of the lexicon.</p>
252
- */
137
+
253
138
  LexiconArn?: string;
254
- /**
255
- * <p>Number of lexemes in the lexicon.</p>
256
- */
139
+
257
140
  LexemesCount?: number;
258
- /**
259
- * <p>Total size of the lexicon, in characters.</p>
260
- */
141
+
261
142
  Size?: number;
262
143
  }
263
144
  export declare namespace LexiconAttributes {
264
- /**
265
- * @internal
266
- */
145
+
267
146
  const filterSensitiveLog: (obj: LexiconAttributes) => any;
268
147
  }
269
148
  export interface GetLexiconOutput {
270
- /**
271
- * <p>Lexicon object that provides name and the string content of the
272
- * lexicon. </p>
273
- */
149
+
274
150
  Lexicon?: Lexicon;
275
- /**
276
- * <p>Metadata of the lexicon, including phonetic alphabetic used,
277
- * language code, lexicon ARN, number of lexemes defined in the lexicon, and
278
- * size of lexicon in bytes.</p>
279
- */
151
+
280
152
  LexiconAttributes?: LexiconAttributes;
281
153
  }
282
154
  export declare namespace GetLexiconOutput {
283
- /**
284
- * @internal
285
- */
155
+
286
156
  const filterSensitiveLog: (obj: GetLexiconOutput) => any;
287
157
  }
288
158
  export interface GetSpeechSynthesisTaskInput {
289
- /**
290
- * <p>The Amazon Polly generated identifier for a speech synthesis task.</p>
291
- */
159
+
292
160
  TaskId: string | undefined;
293
161
  }
294
162
  export declare namespace GetSpeechSynthesisTaskInput {
295
- /**
296
- * @internal
297
- */
163
+
298
164
  const filterSensitiveLog: (obj: GetSpeechSynthesisTaskInput) => any;
299
165
  }
300
166
  export declare enum OutputFormat {
@@ -319,717 +185,359 @@ export declare enum TextType {
319
185
  SSML = "ssml",
320
186
  TEXT = "text"
321
187
  }
322
- /**
323
- * <p>SynthesisTask object that provides information about a speech
324
- * synthesis task.</p>
325
- */
188
+
326
189
  export interface SynthesisTask {
327
- /**
328
- * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
329
- * for Amazon Polly to use when processing input text for speech synthesis. Using a
330
- * voice that is not supported for the engine selected will result in an
331
- * error.</p>
332
- */
190
+
333
191
  Engine?: Engine | string;
334
- /**
335
- * <p>The Amazon Polly generated identifier for a speech synthesis task.</p>
336
- */
192
+
337
193
  TaskId?: string;
338
- /**
339
- * <p>Current status of the individual speech synthesis task.</p>
340
- */
194
+
341
195
  TaskStatus?: TaskStatus | string;
342
- /**
343
- * <p>Reason for the current status of a specific speech synthesis task,
344
- * including errors if the task has failed.</p>
345
- */
196
+
346
197
  TaskStatusReason?: string;
347
- /**
348
- * <p>Pathway for the output speech file.</p>
349
- */
198
+
350
199
  OutputUri?: string;
351
- /**
352
- * <p>Timestamp for the time the synthesis task was started.</p>
353
- */
200
+
354
201
  CreationTime?: Date;
355
- /**
356
- * <p>Number of billable characters synthesized.</p>
357
- */
202
+
358
203
  RequestCharacters?: number;
359
- /**
360
- * <p>ARN for the SNS topic optionally used for providing status
361
- * notification for a speech synthesis task.</p>
362
- */
204
+
363
205
  SnsTopicArn?: string;
364
- /**
365
- * <p>List of one or more pronunciation lexicon names you want the service
366
- * to apply during synthesis. Lexicons are applied only if the language of
367
- * the lexicon is the same as the language of the voice. </p>
368
- */
206
+
369
207
  LexiconNames?: string[];
370
- /**
371
- * <p>The format in which the returned output will be encoded. For audio
372
- * stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will
373
- * be json. </p>
374
- */
208
+
375
209
  OutputFormat?: OutputFormat | string;
376
- /**
377
- * <p>The audio frequency specified in Hz.</p>
378
- * <p>The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
379
- * and "24000". The default value for standard voices is "22050". The default
380
- * value for neural voices is "24000".</p>
381
- * <p>Valid values for pcm are "8000" and "16000" The default value is
382
- * "16000". </p>
383
- */
210
+
384
211
  SampleRate?: string;
385
- /**
386
- * <p>The type of speech marks returned for the input text.</p>
387
- */
212
+
388
213
  SpeechMarkTypes?: (SpeechMarkType | string)[];
389
- /**
390
- * <p>Specifies whether the input text is plain text or SSML. The default
391
- * value is plain text. </p>
392
- */
214
+
393
215
  TextType?: TextType | string;
394
- /**
395
- * <p>Voice ID to use for the synthesis. </p>
396
- */
216
+
397
217
  VoiceId?: VoiceId | string;
398
- /**
399
- * <p>Optional language code for a synthesis task. This is only necessary if
400
- * using a bilingual voice, such as Aditi, which can be used for either
401
- * Indian English (en-IN) or Hindi (hi-IN). </p>
402
- * <p>If a bilingual voice is used and no language code is specified, Amazon Polly
403
- * uses the default language of the bilingual voice. The default language for
404
- * any voice is the one returned by the <a href="https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html">DescribeVoices</a> operation for the <code>LanguageCode</code>
405
- * parameter. For example, if no language code is specified, Aditi will use
406
- * Indian English rather than Hindi.</p>
407
- */
218
+
408
219
  LanguageCode?: LanguageCode | string;
409
220
  }
410
221
  export declare namespace SynthesisTask {
411
- /**
412
- * @internal
413
- */
222
+
414
223
  const filterSensitiveLog: (obj: SynthesisTask) => any;
415
224
  }
416
225
  export interface GetSpeechSynthesisTaskOutput {
417
- /**
418
- * <p>SynthesisTask object that provides information from the requested
419
- * task, including output format, creation time, task status, and so
420
- * on.</p>
421
- */
226
+
422
227
  SynthesisTask?: SynthesisTask;
423
228
  }
424
229
  export declare namespace GetSpeechSynthesisTaskOutput {
425
- /**
426
- * @internal
427
- */
230
+
428
231
  const filterSensitiveLog: (obj: GetSpeechSynthesisTaskOutput) => any;
429
232
  }
430
- /**
431
- * <p>The provided Task ID is not valid. Please provide a valid Task ID and
432
- * try again.</p>
433
- */
233
+
434
234
  export interface InvalidTaskIdException extends __SmithyException, $MetadataBearer {
435
235
  name: "InvalidTaskIdException";
436
236
  $fault: "client";
437
237
  message?: string;
438
238
  }
439
239
  export declare namespace InvalidTaskIdException {
440
- /**
441
- * @internal
442
- */
240
+
443
241
  const filterSensitiveLog: (obj: InvalidTaskIdException) => any;
444
242
  }
445
- /**
446
- * <p>The Speech Synthesis task with requested Task ID cannot be
447
- * found.</p>
448
- */
243
+
449
244
  export interface SynthesisTaskNotFoundException extends __SmithyException, $MetadataBearer {
450
245
  name: "SynthesisTaskNotFoundException";
451
246
  $fault: "client";
452
247
  message?: string;
453
248
  }
454
249
  export declare namespace SynthesisTaskNotFoundException {
455
- /**
456
- * @internal
457
- */
250
+
458
251
  const filterSensitiveLog: (obj: SynthesisTaskNotFoundException) => any;
459
252
  }
460
- /**
461
- * <p>Amazon Polly can't find the specified lexicon. Verify that the lexicon's
462
- * name is spelled correctly, and then try again.</p>
463
- */
253
+
464
254
  export interface InvalidLexiconException extends __SmithyException, $MetadataBearer {
465
255
  name: "InvalidLexiconException";
466
256
  $fault: "client";
467
257
  message?: string;
468
258
  }
469
259
  export declare namespace InvalidLexiconException {
470
- /**
471
- * @internal
472
- */
260
+
473
261
  const filterSensitiveLog: (obj: InvalidLexiconException) => any;
474
262
  }
475
- /**
476
- * <p>The provided Amazon S3 bucket name is invalid. Please check your input
477
- * with S3 bucket naming requirements and try again.</p>
478
- */
263
+
479
264
  export interface InvalidS3BucketException extends __SmithyException, $MetadataBearer {
480
265
  name: "InvalidS3BucketException";
481
266
  $fault: "client";
482
267
  message?: string;
483
268
  }
484
269
  export declare namespace InvalidS3BucketException {
485
- /**
486
- * @internal
487
- */
270
+
488
271
  const filterSensitiveLog: (obj: InvalidS3BucketException) => any;
489
272
  }
490
- /**
491
- * <p>The provided Amazon S3 key prefix is invalid. Please provide a valid
492
- * S3 object key name.</p>
493
- */
273
+
494
274
  export interface InvalidS3KeyException extends __SmithyException, $MetadataBearer {
495
275
  name: "InvalidS3KeyException";
496
276
  $fault: "client";
497
277
  message?: string;
498
278
  }
499
279
  export declare namespace InvalidS3KeyException {
500
- /**
501
- * @internal
502
- */
280
+
503
281
  const filterSensitiveLog: (obj: InvalidS3KeyException) => any;
504
282
  }
505
- /**
506
- * <p>The specified sample rate is not valid.</p>
507
- */
283
+
508
284
  export interface InvalidSampleRateException extends __SmithyException, $MetadataBearer {
509
285
  name: "InvalidSampleRateException";
510
286
  $fault: "client";
511
287
  message?: string;
512
288
  }
513
289
  export declare namespace InvalidSampleRateException {
514
- /**
515
- * @internal
516
- */
290
+
517
291
  const filterSensitiveLog: (obj: InvalidSampleRateException) => any;
518
292
  }
519
- /**
520
- * <p>The provided SNS topic ARN is invalid. Please provide a valid SNS
521
- * topic ARN and try again.</p>
522
- */
293
+
523
294
  export interface InvalidSnsTopicArnException extends __SmithyException, $MetadataBearer {
524
295
  name: "InvalidSnsTopicArnException";
525
296
  $fault: "client";
526
297
  message?: string;
527
298
  }
528
299
  export declare namespace InvalidSnsTopicArnException {
529
- /**
530
- * @internal
531
- */
300
+
532
301
  const filterSensitiveLog: (obj: InvalidSnsTopicArnException) => any;
533
302
  }
534
- /**
535
- * <p>The SSML you provided is invalid. Verify the SSML syntax, spelling
536
- * of tags and values, and then try again.</p>
537
- */
303
+
538
304
  export interface InvalidSsmlException extends __SmithyException, $MetadataBearer {
539
305
  name: "InvalidSsmlException";
540
306
  $fault: "client";
541
307
  message?: string;
542
308
  }
543
309
  export declare namespace InvalidSsmlException {
544
- /**
545
- * @internal
546
- */
310
+
547
311
  const filterSensitiveLog: (obj: InvalidSsmlException) => any;
548
312
  }
549
- /**
550
- * <p>The language specified is not currently supported by Amazon Polly in this
551
- * capacity.</p>
552
- */
313
+
553
314
  export interface LanguageNotSupportedException extends __SmithyException, $MetadataBearer {
554
315
  name: "LanguageNotSupportedException";
555
316
  $fault: "client";
556
317
  message?: string;
557
318
  }
558
319
  export declare namespace LanguageNotSupportedException {
559
- /**
560
- * @internal
561
- */
320
+
562
321
  const filterSensitiveLog: (obj: LanguageNotSupportedException) => any;
563
322
  }
564
- /**
565
- * <p>Describes the content of the lexicon.</p>
566
- */
323
+
567
324
  export interface LexiconDescription {
568
- /**
569
- * <p>Name of the lexicon.</p>
570
- */
325
+
571
326
  Name?: string;
572
- /**
573
- * <p>Provides lexicon metadata.</p>
574
- */
327
+
575
328
  Attributes?: LexiconAttributes;
576
329
  }
577
330
  export declare namespace LexiconDescription {
578
- /**
579
- * @internal
580
- */
331
+
581
332
  const filterSensitiveLog: (obj: LexiconDescription) => any;
582
333
  }
583
- /**
584
- * <p>The maximum size of the specified lexicon would be exceeded by this
585
- * operation.</p>
586
- */
334
+
587
335
  export interface LexiconSizeExceededException extends __SmithyException, $MetadataBearer {
588
336
  name: "LexiconSizeExceededException";
589
337
  $fault: "client";
590
338
  message?: string;
591
339
  }
592
340
  export declare namespace LexiconSizeExceededException {
593
- /**
594
- * @internal
595
- */
341
+
596
342
  const filterSensitiveLog: (obj: LexiconSizeExceededException) => any;
597
343
  }
598
344
  export interface ListLexiconsInput {
599
- /**
600
- * <p>An opaque pagination token returned from previous
601
- * <code>ListLexicons</code> operation. If present, indicates where to
602
- * continue the list of lexicons.</p>
603
- */
345
+
604
346
  NextToken?: string;
605
347
  }
606
348
  export declare namespace ListLexiconsInput {
607
- /**
608
- * @internal
609
- */
349
+
610
350
  const filterSensitiveLog: (obj: ListLexiconsInput) => any;
611
351
  }
612
352
  export interface ListLexiconsOutput {
613
- /**
614
- * <p>A list of lexicon names and attributes.</p>
615
- */
353
+
616
354
  Lexicons?: LexiconDescription[];
617
- /**
618
- * <p>The pagination token to use in the next request to continue the
619
- * listing of lexicons. <code>NextToken</code> is returned only if the
620
- * response is truncated.</p>
621
- */
355
+
622
356
  NextToken?: string;
623
357
  }
624
358
  export declare namespace ListLexiconsOutput {
625
- /**
626
- * @internal
627
- */
359
+
628
360
  const filterSensitiveLog: (obj: ListLexiconsOutput) => any;
629
361
  }
630
362
  export interface ListSpeechSynthesisTasksInput {
631
- /**
632
- * <p>Maximum number of speech synthesis tasks returned in a List
633
- * operation.</p>
634
- */
363
+
635
364
  MaxResults?: number;
636
- /**
637
- * <p>The pagination token to use in the next request to continue the
638
- * listing of speech synthesis tasks. </p>
639
- */
365
+
640
366
  NextToken?: string;
641
- /**
642
- * <p>Status of the speech synthesis tasks returned in a List
643
- * operation</p>
644
- */
367
+
645
368
  Status?: TaskStatus | string;
646
369
  }
647
370
  export declare namespace ListSpeechSynthesisTasksInput {
648
- /**
649
- * @internal
650
- */
371
+
651
372
  const filterSensitiveLog: (obj: ListSpeechSynthesisTasksInput) => any;
652
373
  }
653
374
  export interface ListSpeechSynthesisTasksOutput {
654
- /**
655
- * <p>An opaque pagination token returned from the previous List operation
656
- * in this request. If present, this indicates where to continue the
657
- * listing.</p>
658
- */
375
+
659
376
  NextToken?: string;
660
- /**
661
- * <p>List of SynthesisTask objects that provides information from the
662
- * specified task in the list request, including output format, creation
663
- * time, task status, and so on.</p>
664
- */
377
+
665
378
  SynthesisTasks?: SynthesisTask[];
666
379
  }
667
380
  export declare namespace ListSpeechSynthesisTasksOutput {
668
- /**
669
- * @internal
670
- */
381
+
671
382
  const filterSensitiveLog: (obj: ListSpeechSynthesisTasksOutput) => any;
672
383
  }
673
- /**
674
- * <p>Speech marks are not supported for the <code>OutputFormat</code>
675
- * selected. Speech marks are only available for content in <code>json</code>
676
- * format.</p>
677
- */
384
+
678
385
  export interface MarksNotSupportedForFormatException extends __SmithyException, $MetadataBearer {
679
386
  name: "MarksNotSupportedForFormatException";
680
387
  $fault: "client";
681
388
  message?: string;
682
389
  }
683
390
  export declare namespace MarksNotSupportedForFormatException {
684
- /**
685
- * @internal
686
- */
391
+
687
392
  const filterSensitiveLog: (obj: MarksNotSupportedForFormatException) => any;
688
393
  }
689
- /**
690
- * <p>The maximum size of the lexeme would be exceeded by this
691
- * operation.</p>
692
- */
394
+
693
395
  export interface MaxLexemeLengthExceededException extends __SmithyException, $MetadataBearer {
694
396
  name: "MaxLexemeLengthExceededException";
695
397
  $fault: "client";
696
398
  message?: string;
697
399
  }
698
400
  export declare namespace MaxLexemeLengthExceededException {
699
- /**
700
- * @internal
701
- */
401
+
702
402
  const filterSensitiveLog: (obj: MaxLexemeLengthExceededException) => any;
703
403
  }
704
- /**
705
- * <p>The maximum number of lexicons would be exceeded by this
706
- * operation.</p>
707
- */
404
+
708
405
  export interface MaxLexiconsNumberExceededException extends __SmithyException, $MetadataBearer {
709
406
  name: "MaxLexiconsNumberExceededException";
710
407
  $fault: "client";
711
408
  message?: string;
712
409
  }
713
410
  export declare namespace MaxLexiconsNumberExceededException {
714
- /**
715
- * @internal
716
- */
411
+
717
412
  const filterSensitiveLog: (obj: MaxLexiconsNumberExceededException) => any;
718
413
  }
719
414
  export interface PutLexiconInput {
720
- /**
721
- * <p>Name of the lexicon. The name must follow the regular express
722
- * format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive
723
- * alphanumeric string up to 20 characters long. </p>
724
- */
415
+
725
416
  Name: string | undefined;
726
- /**
727
- * <p>Content of the PLS lexicon as string data.</p>
728
- */
417
+
729
418
  Content: string | undefined;
730
419
  }
731
420
  export declare namespace PutLexiconInput {
732
- /**
733
- * @internal
734
- */
421
+
735
422
  const filterSensitiveLog: (obj: PutLexiconInput) => any;
736
423
  }
737
424
  export interface PutLexiconOutput {
738
425
  }
739
426
  export declare namespace PutLexiconOutput {
740
- /**
741
- * @internal
742
- */
427
+
743
428
  const filterSensitiveLog: (obj: PutLexiconOutput) => any;
744
429
  }
745
- /**
746
- * <p>The alphabet specified by the lexicon is not a supported alphabet.
747
- * Valid values are <code>x-sampa</code> and <code>ipa</code>.</p>
748
- */
430
+
749
431
  export interface UnsupportedPlsAlphabetException extends __SmithyException, $MetadataBearer {
750
432
  name: "UnsupportedPlsAlphabetException";
751
433
  $fault: "client";
752
434
  message?: string;
753
435
  }
754
436
  export declare namespace UnsupportedPlsAlphabetException {
755
- /**
756
- * @internal
757
- */
437
+
758
438
  const filterSensitiveLog: (obj: UnsupportedPlsAlphabetException) => any;
759
439
  }
760
- /**
761
- * <p>The language specified in the lexicon is unsupported. For a list of
762
- * supported languages, see <a href="https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html">Lexicon Attributes</a>.</p>
763
- */
440
+
764
441
  export interface UnsupportedPlsLanguageException extends __SmithyException, $MetadataBearer {
765
442
  name: "UnsupportedPlsLanguageException";
766
443
  $fault: "client";
767
444
  message?: string;
768
445
  }
769
446
  export declare namespace UnsupportedPlsLanguageException {
770
- /**
771
- * @internal
772
- */
447
+
773
448
  const filterSensitiveLog: (obj: UnsupportedPlsLanguageException) => any;
774
449
  }
775
- /**
776
- * <p>SSML speech marks are not supported for plain text-type
777
- * input.</p>
778
- */
450
+
779
451
  export interface SsmlMarksNotSupportedForTextTypeException extends __SmithyException, $MetadataBearer {
780
452
  name: "SsmlMarksNotSupportedForTextTypeException";
781
453
  $fault: "client";
782
454
  message?: string;
783
455
  }
784
456
  export declare namespace SsmlMarksNotSupportedForTextTypeException {
785
- /**
786
- * @internal
787
- */
457
+
788
458
  const filterSensitiveLog: (obj: SsmlMarksNotSupportedForTextTypeException) => any;
789
459
  }
790
460
  export interface StartSpeechSynthesisTaskInput {
791
- /**
792
- * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
793
- * for Amazon Polly to use when processing input text for speech synthesis. Using a
794
- * voice that is not supported for the engine selected will result in an
795
- * error.</p>
796
- */
461
+
797
462
  Engine?: Engine | string;
798
- /**
799
- * <p>Optional language code for the Speech Synthesis request. This is only
800
- * necessary if using a bilingual voice, such as Aditi, which can be used for
801
- * either Indian English (en-IN) or Hindi (hi-IN). </p>
802
- * <p>If a bilingual voice is used and no language code is specified, Amazon Polly
803
- * uses the default language of the bilingual voice. The default language for
804
- * any voice is the one returned by the <a href="https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html">DescribeVoices</a> operation for the <code>LanguageCode</code>
805
- * parameter. For example, if no language code is specified, Aditi will use
806
- * Indian English rather than Hindi.</p>
807
- */
463
+
808
464
  LanguageCode?: LanguageCode | string;
809
- /**
810
- * <p>List of one or more pronunciation lexicon names you want the service
811
- * to apply during synthesis. Lexicons are applied only if the language of
812
- * the lexicon is the same as the language of the voice. </p>
813
- */
465
+
814
466
  LexiconNames?: string[];
815
- /**
816
- * <p>The format in which the returned output will be encoded. For audio
817
- * stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will
818
- * be json. </p>
819
- */
467
+
820
468
  OutputFormat: OutputFormat | string | undefined;
821
- /**
822
- * <p>Amazon S3 bucket name to which the output file will be saved.</p>
823
- */
469
+
824
470
  OutputS3BucketName: string | undefined;
825
- /**
826
- * <p>The Amazon S3 key prefix for the output speech file.</p>
827
- */
471
+
828
472
  OutputS3KeyPrefix?: string;
829
- /**
830
- * <p>The audio frequency specified in Hz.</p>
831
- * <p>The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
832
- * and "24000". The default value for standard voices is "22050". The default
833
- * value for neural voices is "24000".</p>
834
- * <p>Valid values for pcm are "8000" and "16000" The default value is
835
- * "16000". </p>
836
- */
473
+
837
474
  SampleRate?: string;
838
- /**
839
- * <p>ARN for the SNS topic optionally used for providing status
840
- * notification for a speech synthesis task.</p>
841
- */
475
+
842
476
  SnsTopicArn?: string;
843
- /**
844
- * <p>The type of speech marks returned for the input text.</p>
845
- */
477
+
846
478
  SpeechMarkTypes?: (SpeechMarkType | string)[];
847
- /**
848
- * <p>The input text to synthesize. If you specify ssml as the TextType,
849
- * follow the SSML format for the input text. </p>
850
- */
479
+
851
480
  Text: string | undefined;
852
- /**
853
- * <p>Specifies whether the input text is plain text or SSML. The default
854
- * value is plain text. </p>
855
- */
481
+
856
482
  TextType?: TextType | string;
857
- /**
858
- * <p>Voice ID to use for the synthesis. </p>
859
- */
483
+
860
484
  VoiceId: VoiceId | string | undefined;
861
485
  }
862
486
  export declare namespace StartSpeechSynthesisTaskInput {
863
- /**
864
- * @internal
865
- */
487
+
866
488
  const filterSensitiveLog: (obj: StartSpeechSynthesisTaskInput) => any;
867
489
  }
868
490
  export interface StartSpeechSynthesisTaskOutput {
869
- /**
870
- * <p>SynthesisTask object that provides information and attributes about a
871
- * newly submitted speech synthesis task.</p>
872
- */
491
+
873
492
  SynthesisTask?: SynthesisTask;
874
493
  }
875
494
  export declare namespace StartSpeechSynthesisTaskOutput {
876
- /**
877
- * @internal
878
- */
495
+
879
496
  const filterSensitiveLog: (obj: StartSpeechSynthesisTaskOutput) => any;
880
497
  }
881
- /**
882
- * <p>The value of the "Text" parameter is longer than the accepted
883
- * limits. For the <code>SynthesizeSpeech</code> API, the limit for input
884
- * text is a maximum of 6000 characters total, of which no more than 3000 can
885
- * be billed characters. For the <code>StartSpeechSynthesisTask</code> API,
886
- * the maximum is 200,000 characters, of which no more than 100,000 can be
887
- * billed characters. SSML tags are not counted as billed
888
- * characters.</p>
889
- */
498
+
890
499
  export interface TextLengthExceededException extends __SmithyException, $MetadataBearer {
891
500
  name: "TextLengthExceededException";
892
501
  $fault: "client";
893
502
  message?: string;
894
503
  }
895
504
  export declare namespace TextLengthExceededException {
896
- /**
897
- * @internal
898
- */
505
+
899
506
  const filterSensitiveLog: (obj: TextLengthExceededException) => any;
900
507
  }
901
508
  export interface SynthesizeSpeechInput {
902
- /**
903
- * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
904
- * for Amazon Polly to use when processing input text for speech synthesis. For
905
- * information on Amazon Polly voices and which voices are available in
906
- * standard-only, NTTS-only, and both standard and NTTS formats, see <a href="https://docs.aws.amazon.com/polly/latest/dg/voicelist.html">Available Voices</a>.</p>
907
- * <p>
908
- * <b>NTTS-only voices</b>
909
- * </p>
910
- * <p>When using NTTS-only voices such as Kevin (en-US), this parameter is
911
- * required and must be set to <code>neural</code>. If the engine is not
912
- * specified, or is set to <code>standard</code>, this will result in an
913
- * error. </p>
914
- * <p>Type: String</p>
915
- * <p>Valid Values: <code>standard</code> | <code>neural</code>
916
- * </p>
917
- * <p>Required: Yes</p>
918
- *
919
- * <p>
920
- * <b>Standard voices</b>
921
- * </p>
922
- * <p>For standard voices, this is not required; the engine parameter
923
- * defaults to <code>standard</code>. If the engine is not specified, or is
924
- * set to <code>standard</code> and an NTTS-only voice is selected, this will
925
- * result in an error. </p>
926
- */
509
+
927
510
  Engine?: Engine | string;
928
- /**
929
- * <p>Optional language code for the Synthesize Speech request. This is only
930
- * necessary if using a bilingual voice, such as Aditi, which can be used for
931
- * either Indian English (en-IN) or Hindi (hi-IN). </p>
932
- * <p>If a bilingual voice is used and no language code is specified, Amazon Polly
933
- * uses the default language of the bilingual voice. The default language for
934
- * any voice is the one returned by the <a href="https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html">DescribeVoices</a> operation for the <code>LanguageCode</code>
935
- * parameter. For example, if no language code is specified, Aditi will use
936
- * Indian English rather than Hindi.</p>
937
- */
511
+
938
512
  LanguageCode?: LanguageCode | string;
939
- /**
940
- * <p>List of one or more pronunciation lexicon names you want the
941
- * service to apply during synthesis. Lexicons are applied only if the
942
- * language of the lexicon is the same as the language of the voice. For
943
- * information about storing lexicons, see <a href="https://docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html">PutLexicon</a>.</p>
944
- */
513
+
945
514
  LexiconNames?: string[];
946
- /**
947
- * <p> The format in which the returned output will be encoded. For audio
948
- * stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will
949
- * be json. </p>
950
- * <p>When pcm is used, the content returned is audio/pcm in a signed
951
- * 16-bit, 1 channel (mono), little-endian format. </p>
952
- */
515
+
953
516
  OutputFormat: OutputFormat | string | undefined;
954
- /**
955
- * <p>The audio frequency specified in Hz.</p>
956
- * <p>The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
957
- * and "24000". The default value for standard voices is "22050". The default
958
- * value for neural voices is "24000".</p>
959
- * <p>Valid values for pcm are "8000" and "16000" The default value is
960
- * "16000". </p>
961
- */
517
+
962
518
  SampleRate?: string;
963
- /**
964
- * <p>The type of speech marks returned for the input text.</p>
965
- */
519
+
966
520
  SpeechMarkTypes?: (SpeechMarkType | string)[];
967
- /**
968
- * <p> Input text to synthesize. If you specify <code>ssml</code> as the
969
- * <code>TextType</code>, follow the SSML format for the input text.
970
- * </p>
971
- */
521
+
972
522
  Text: string | undefined;
973
- /**
974
- * <p> Specifies whether the input text is plain text or SSML. The
975
- * default value is plain text. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/ssml.html">Using
976
- * SSML</a>.</p>
977
- */
523
+
978
524
  TextType?: TextType | string;
979
- /**
980
- * <p> Voice ID to use for the synthesis. You can get a list of available
981
- * voice IDs by calling the <a href="https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html">DescribeVoices</a> operation. </p>
982
- */
525
+
983
526
  VoiceId: VoiceId | string | undefined;
984
527
  }
985
528
  export declare namespace SynthesizeSpeechInput {
986
- /**
987
- * @internal
988
- */
529
+
989
530
  const filterSensitiveLog: (obj: SynthesizeSpeechInput) => any;
990
531
  }
991
532
  export interface SynthesizeSpeechOutput {
992
- /**
993
- * <p> Stream containing the synthesized speech. </p>
994
- */
533
+
995
534
  AudioStream?: Readable | ReadableStream | Blob;
996
- /**
997
- * <p> Specifies the type audio stream. This should reflect the
998
- * <code>OutputFormat</code> parameter in your request. </p>
999
- * <ul>
1000
- * <li>
1001
- * <p> If you request <code>mp3</code> as the
1002
- * <code>OutputFormat</code>, the <code>ContentType</code> returned is
1003
- * audio/mpeg. </p>
1004
- * </li>
1005
- * <li>
1006
- * <p> If you request <code>ogg_vorbis</code> as the
1007
- * <code>OutputFormat</code>, the <code>ContentType</code> returned is
1008
- * audio/ogg. </p>
1009
- * </li>
1010
- * <li>
1011
- * <p> If you request <code>pcm</code> as the
1012
- * <code>OutputFormat</code>, the <code>ContentType</code> returned is
1013
- * audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
1014
- * </p>
1015
- * </li>
1016
- * <li>
1017
- * <p>If you request <code>json</code> as the
1018
- * <code>OutputFormat</code>, the <code>ContentType</code> returned is
1019
- * audio/json.</p>
1020
- * </li>
1021
- * </ul>
1022
- * <p> </p>
1023
- */
535
+
1024
536
  ContentType?: string;
1025
- /**
1026
- * <p>Number of characters synthesized.</p>
1027
- */
537
+
1028
538
  RequestCharacters?: number;
1029
539
  }
1030
540
  export declare namespace SynthesizeSpeechOutput {
1031
- /**
1032
- * @internal
1033
- */
541
+
1034
542
  const filterSensitiveLog: (obj: SynthesizeSpeechOutput) => any;
1035
543
  }