@aws-sdk/client-polly 3.35.0 → 3.38.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 (142) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/Polly.js +0 -9
  3. package/dist-cjs/PollyClient.js +0 -14
  4. package/dist-cjs/commands/DeleteLexiconCommand.js +0 -28
  5. package/dist-cjs/commands/DescribeVoicesCommand.js +0 -43
  6. package/dist-cjs/commands/GetLexiconCommand.js +0 -26
  7. package/dist-cjs/commands/GetSpeechSynthesisTaskCommand.js +0 -28
  8. package/dist-cjs/commands/ListLexiconsCommand.js +0 -25
  9. package/dist-cjs/commands/ListSpeechSynthesisTasksCommand.js +0 -27
  10. package/dist-cjs/commands/PutLexiconCommand.js +0 -30
  11. package/dist-cjs/commands/StartSpeechSynthesisTaskCommand.js +0 -34
  12. package/dist-cjs/commands/SynthesizeSpeechCommand.js +0 -29
  13. package/dist-cjs/commands/index.js +12 -0
  14. package/dist-cjs/endpoints.js +1 -2
  15. package/dist-cjs/index.js +4 -14
  16. package/dist-cjs/models/index.js +0 -1
  17. package/dist-cjs/models/models_0.js +0 -133
  18. package/dist-cjs/pagination/Interfaces.js +0 -1
  19. package/dist-cjs/pagination/ListSpeechSynthesisTasksPaginator.js +0 -11
  20. package/dist-cjs/pagination/index.js +5 -0
  21. package/dist-cjs/protocols/Aws_restJson1.js +0 -6
  22. package/dist-cjs/runtimeConfig.browser.js +1 -6
  23. package/dist-cjs/runtimeConfig.js +2 -7
  24. package/dist-cjs/runtimeConfig.native.js +0 -4
  25. package/dist-cjs/runtimeConfig.shared.js +0 -4
  26. package/dist-es/Polly.js +0 -1
  27. package/dist-es/PollyClient.js +0 -1
  28. package/dist-es/commands/DeleteLexiconCommand.js +0 -1
  29. package/dist-es/commands/DescribeVoicesCommand.js +0 -1
  30. package/dist-es/commands/GetLexiconCommand.js +0 -1
  31. package/dist-es/commands/GetSpeechSynthesisTaskCommand.js +0 -1
  32. package/dist-es/commands/ListLexiconsCommand.js +0 -1
  33. package/dist-es/commands/ListSpeechSynthesisTasksCommand.js +0 -1
  34. package/dist-es/commands/PutLexiconCommand.js +0 -1
  35. package/dist-es/commands/StartSpeechSynthesisTaskCommand.js +0 -1
  36. package/dist-es/commands/SynthesizeSpeechCommand.js +0 -1
  37. package/dist-es/commands/index.js +9 -0
  38. package/dist-es/endpoints.js +1 -2
  39. package/dist-es/index.js +4 -14
  40. package/dist-es/models/index.js +0 -1
  41. package/dist-es/models/models_0.js +0 -1
  42. package/dist-es/pagination/Interfaces.js +0 -1
  43. package/dist-es/pagination/ListSpeechSynthesisTasksPaginator.js +0 -1
  44. package/dist-es/pagination/index.js +2 -0
  45. package/dist-es/protocols/Aws_restJson1.js +0 -1
  46. package/dist-es/runtimeConfig.browser.js +1 -2
  47. package/dist-es/runtimeConfig.js +2 -3
  48. package/dist-es/runtimeConfig.native.js +0 -1
  49. package/dist-es/runtimeConfig.shared.js +0 -1
  50. package/dist-types/commands/index.d.ts +9 -0
  51. package/dist-types/index.d.ts +4 -13
  52. package/dist-types/pagination/index.d.ts +2 -0
  53. package/dist-types/ts3.4/Polly.d.ts +10 -80
  54. package/dist-types/ts3.4/PollyClient.d.ts +24 -94
  55. package/dist-types/ts3.4/commands/DeleteLexiconCommand.d.ts +2 -23
  56. package/dist-types/ts3.4/commands/DescribeVoicesCommand.d.ts +2 -38
  57. package/dist-types/ts3.4/commands/GetLexiconCommand.d.ts +2 -21
  58. package/dist-types/ts3.4/commands/GetSpeechSynthesisTaskCommand.d.ts +2 -23
  59. package/dist-types/ts3.4/commands/ListLexiconsCommand.d.ts +2 -20
  60. package/dist-types/ts3.4/commands/ListSpeechSynthesisTasksCommand.d.ts +2 -22
  61. package/dist-types/ts3.4/commands/PutLexiconCommand.d.ts +2 -25
  62. package/dist-types/ts3.4/commands/StartSpeechSynthesisTaskCommand.d.ts +2 -29
  63. package/dist-types/ts3.4/commands/SynthesizeSpeechCommand.d.ts +2 -24
  64. package/dist-types/ts3.4/commands/index.d.ts +9 -0
  65. package/dist-types/ts3.4/index.d.ts +4 -13
  66. package/dist-types/ts3.4/models/models_0.d.ts +150 -642
  67. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  68. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  69. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  70. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  71. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  72. package/package.json +33 -30
  73. package/dist-cjs/Polly.js.map +0 -1
  74. package/dist-cjs/PollyClient.js.map +0 -1
  75. package/dist-cjs/commands/DeleteLexiconCommand.js.map +0 -1
  76. package/dist-cjs/commands/DescribeVoicesCommand.js.map +0 -1
  77. package/dist-cjs/commands/GetLexiconCommand.js.map +0 -1
  78. package/dist-cjs/commands/GetSpeechSynthesisTaskCommand.js.map +0 -1
  79. package/dist-cjs/commands/ListLexiconsCommand.js.map +0 -1
  80. package/dist-cjs/commands/ListSpeechSynthesisTasksCommand.js.map +0 -1
  81. package/dist-cjs/commands/PutLexiconCommand.js.map +0 -1
  82. package/dist-cjs/commands/StartSpeechSynthesisTaskCommand.js.map +0 -1
  83. package/dist-cjs/commands/SynthesizeSpeechCommand.js.map +0 -1
  84. package/dist-cjs/endpoints.js.map +0 -1
  85. package/dist-cjs/index.js.map +0 -1
  86. package/dist-cjs/models/index.js.map +0 -1
  87. package/dist-cjs/models/models_0.js.map +0 -1
  88. package/dist-cjs/pagination/Interfaces.js.map +0 -1
  89. package/dist-cjs/pagination/ListSpeechSynthesisTasksPaginator.js.map +0 -1
  90. package/dist-cjs/protocols/Aws_restJson1.js.map +0 -1
  91. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  92. package/dist-cjs/runtimeConfig.js.map +0 -1
  93. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  94. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  95. package/dist-es/Polly.js.map +0 -1
  96. package/dist-es/PollyClient.js.map +0 -1
  97. package/dist-es/commands/DeleteLexiconCommand.js.map +0 -1
  98. package/dist-es/commands/DescribeVoicesCommand.js.map +0 -1
  99. package/dist-es/commands/GetLexiconCommand.js.map +0 -1
  100. package/dist-es/commands/GetSpeechSynthesisTaskCommand.js.map +0 -1
  101. package/dist-es/commands/ListLexiconsCommand.js.map +0 -1
  102. package/dist-es/commands/ListSpeechSynthesisTasksCommand.js.map +0 -1
  103. package/dist-es/commands/PutLexiconCommand.js.map +0 -1
  104. package/dist-es/commands/StartSpeechSynthesisTaskCommand.js.map +0 -1
  105. package/dist-es/commands/SynthesizeSpeechCommand.js.map +0 -1
  106. package/dist-es/endpoints.js.map +0 -1
  107. package/dist-es/index.js.map +0 -1
  108. package/dist-es/models/index.js.map +0 -1
  109. package/dist-es/models/models_0.js.map +0 -1
  110. package/dist-es/pagination/Interfaces.js.map +0 -1
  111. package/dist-es/pagination/ListSpeechSynthesisTasksPaginator.js.map +0 -1
  112. package/dist-es/protocols/Aws_restJson1.js.map +0 -1
  113. package/dist-es/runtimeConfig.browser.js.map +0 -1
  114. package/dist-es/runtimeConfig.js.map +0 -1
  115. package/dist-es/runtimeConfig.native.js.map +0 -1
  116. package/dist-es/runtimeConfig.shared.js.map +0 -1
  117. package/jest.config.js +0 -4
  118. package/src/Polly.ts +0 -368
  119. package/src/PollyClient.ts +0 -277
  120. package/src/commands/DeleteLexiconCommand.ts +0 -98
  121. package/src/commands/DescribeVoicesCommand.ts +0 -113
  122. package/src/commands/GetLexiconCommand.ts +0 -96
  123. package/src/commands/GetSpeechSynthesisTaskCommand.ts +0 -98
  124. package/src/commands/ListLexiconsCommand.ts +0 -95
  125. package/src/commands/ListSpeechSynthesisTasksCommand.ts +0 -97
  126. package/src/commands/PutLexiconCommand.ts +0 -100
  127. package/src/commands/StartSpeechSynthesisTaskCommand.ts +0 -104
  128. package/src/commands/SynthesizeSpeechCommand.ts +0 -99
  129. package/src/endpoints.ts +0 -82
  130. package/src/index.ts +0 -14
  131. package/src/models/index.ts +0 -1
  132. package/src/models/models_0.ts +0 -1374
  133. package/src/pagination/Interfaces.ts +0 -8
  134. package/src/pagination/ListSpeechSynthesisTasksPaginator.ts +0 -59
  135. package/src/protocols/Aws_restJson1.ts +0 -1712
  136. package/src/runtimeConfig.browser.ts +0 -41
  137. package/src/runtimeConfig.native.ts +0 -17
  138. package/src/runtimeConfig.shared.ts +0 -17
  139. package/src/runtimeConfig.ts +0 -46
  140. package/tsconfig.es.json +0 -10
  141. package/tsconfig.json +0 -33
  142. package/tsconfig.types.json +0 -9
@@ -1,1374 +0,0 @@
1
- import { SENSITIVE_STRING } from "@aws-sdk/smithy-client";
2
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
3
- import { Readable } from "stream";
4
-
5
- export interface DeleteLexiconInput {
6
- /**
7
- * <p>The name of the lexicon to delete. Must be an existing lexicon in
8
- * the region.</p>
9
- */
10
- Name: string | undefined;
11
- }
12
-
13
- export namespace DeleteLexiconInput {
14
- /**
15
- * @internal
16
- */
17
- export const filterSensitiveLog = (obj: DeleteLexiconInput): any => ({
18
- ...obj,
19
- });
20
- }
21
-
22
- export interface DeleteLexiconOutput {}
23
-
24
- export namespace DeleteLexiconOutput {
25
- /**
26
- * @internal
27
- */
28
- export const filterSensitiveLog = (obj: DeleteLexiconOutput): any => ({
29
- ...obj,
30
- });
31
- }
32
-
33
- /**
34
- * <p>Amazon Polly can't find the specified lexicon. This could be caused by a
35
- * lexicon that is missing, its name is misspelled or specifying a lexicon
36
- * that is in a different region.</p>
37
- * <p>Verify that the lexicon exists, is in the region (see <a>ListLexicons</a>) and that you spelled its name is spelled
38
- * correctly. Then try again.</p>
39
- */
40
- export interface LexiconNotFoundException extends __SmithyException, $MetadataBearer {
41
- name: "LexiconNotFoundException";
42
- $fault: "client";
43
- message?: string;
44
- }
45
-
46
- export namespace LexiconNotFoundException {
47
- /**
48
- * @internal
49
- */
50
- export const filterSensitiveLog = (obj: LexiconNotFoundException): any => ({
51
- ...obj,
52
- });
53
- }
54
-
55
- /**
56
- * <p>An unknown condition has caused a service failure.</p>
57
- */
58
- export interface ServiceFailureException extends __SmithyException, $MetadataBearer {
59
- name: "ServiceFailureException";
60
- $fault: "server";
61
- message?: string;
62
- }
63
-
64
- export namespace ServiceFailureException {
65
- /**
66
- * @internal
67
- */
68
- export const filterSensitiveLog = (obj: ServiceFailureException): any => ({
69
- ...obj,
70
- });
71
- }
72
-
73
- export enum Engine {
74
- NEURAL = "neural",
75
- STANDARD = "standard",
76
- }
77
-
78
- export type LanguageCode =
79
- | "arb"
80
- | "cmn-CN"
81
- | "cy-GB"
82
- | "da-DK"
83
- | "de-DE"
84
- | "en-AU"
85
- | "en-GB"
86
- | "en-GB-WLS"
87
- | "en-IN"
88
- | "en-NZ"
89
- | "en-US"
90
- | "en-ZA"
91
- | "es-ES"
92
- | "es-MX"
93
- | "es-US"
94
- | "fr-CA"
95
- | "fr-FR"
96
- | "hi-IN"
97
- | "is-IS"
98
- | "it-IT"
99
- | "ja-JP"
100
- | "ko-KR"
101
- | "nb-NO"
102
- | "nl-NL"
103
- | "pl-PL"
104
- | "pt-BR"
105
- | "pt-PT"
106
- | "ro-RO"
107
- | "ru-RU"
108
- | "sv-SE"
109
- | "tr-TR";
110
-
111
- export interface DescribeVoicesInput {
112
- /**
113
- * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
114
- * used by Amazon Polly when processing input text for speech synthesis. </p>
115
- */
116
- Engine?: Engine | string;
117
-
118
- /**
119
- * <p> The language identification tag (ISO 639 code for the language
120
- * name-ISO 3166 country code) for filtering the list of voices returned. If
121
- * you don't specify this optional parameter, all available voices are
122
- * returned. </p>
123
- */
124
- LanguageCode?: LanguageCode | string;
125
-
126
- /**
127
- * <p>Boolean value indicating whether to return any bilingual voices that
128
- * use the specified language as an additional language. For instance, if you
129
- * request all languages that use US English (es-US), and there is an Italian
130
- * voice that speaks both Italian (it-IT) and US English, that voice will be
131
- * included if you specify <code>yes</code> but not if you specify
132
- * <code>no</code>.</p>
133
- */
134
- IncludeAdditionalLanguageCodes?: boolean;
135
-
136
- /**
137
- * <p>An opaque pagination token returned from the previous
138
- * <code>DescribeVoices</code> operation. If present, this indicates where
139
- * to continue the listing.</p>
140
- */
141
- NextToken?: string;
142
- }
143
-
144
- export namespace DescribeVoicesInput {
145
- /**
146
- * @internal
147
- */
148
- export const filterSensitiveLog = (obj: DescribeVoicesInput): any => ({
149
- ...obj,
150
- });
151
- }
152
-
153
- export type Gender = "Female" | "Male";
154
-
155
- export type VoiceId =
156
- | "Aditi"
157
- | "Amy"
158
- | "Aria"
159
- | "Astrid"
160
- | "Ayanda"
161
- | "Bianca"
162
- | "Brian"
163
- | "Camila"
164
- | "Carla"
165
- | "Carmen"
166
- | "Celine"
167
- | "Chantal"
168
- | "Conchita"
169
- | "Cristiano"
170
- | "Dora"
171
- | "Emma"
172
- | "Enrique"
173
- | "Ewa"
174
- | "Filiz"
175
- | "Gabrielle"
176
- | "Geraint"
177
- | "Giorgio"
178
- | "Gwyneth"
179
- | "Hans"
180
- | "Ines"
181
- | "Ivy"
182
- | "Jacek"
183
- | "Jan"
184
- | "Joanna"
185
- | "Joey"
186
- | "Justin"
187
- | "Karl"
188
- | "Kendra"
189
- | "Kevin"
190
- | "Kimberly"
191
- | "Lea"
192
- | "Liv"
193
- | "Lotte"
194
- | "Lucia"
195
- | "Lupe"
196
- | "Mads"
197
- | "Maja"
198
- | "Marlene"
199
- | "Mathieu"
200
- | "Matthew"
201
- | "Maxim"
202
- | "Mia"
203
- | "Miguel"
204
- | "Mizuki"
205
- | "Naja"
206
- | "Nicole"
207
- | "Olivia"
208
- | "Penelope"
209
- | "Raveena"
210
- | "Ricardo"
211
- | "Ruben"
212
- | "Russell"
213
- | "Salli"
214
- | "Seoyeon"
215
- | "Takumi"
216
- | "Tatyana"
217
- | "Vicki"
218
- | "Vitoria"
219
- | "Zeina"
220
- | "Zhiyu";
221
-
222
- /**
223
- * <p>Description of the voice.</p>
224
- */
225
- export interface Voice {
226
- /**
227
- * <p>Gender of the voice.</p>
228
- */
229
- Gender?: Gender | string;
230
-
231
- /**
232
- * <p>Amazon Polly assigned voice ID. This is the ID that you specify when
233
- * calling the <code>SynthesizeSpeech</code> operation.</p>
234
- */
235
- Id?: VoiceId | string;
236
-
237
- /**
238
- * <p>Language code of the voice.</p>
239
- */
240
- LanguageCode?: LanguageCode | string;
241
-
242
- /**
243
- * <p>Human readable name of the language in English.</p>
244
- */
245
- LanguageName?: string;
246
-
247
- /**
248
- * <p>Name of the voice (for example, Salli, Kendra, etc.). This provides
249
- * a human readable voice name that you might display in your
250
- * application.</p>
251
- */
252
- Name?: string;
253
-
254
- /**
255
- * <p>Additional codes for languages available for the specified voice in
256
- * addition to its default language. </p>
257
- * <p>For example, the default language for Aditi is Indian English (en-IN)
258
- * because it was first used for that language. Since Aditi is bilingual and
259
- * fluent in both Indian English and Hindi, this parameter would show the
260
- * code <code>hi-IN</code>.</p>
261
- */
262
- AdditionalLanguageCodes?: (LanguageCode | string)[];
263
-
264
- /**
265
- * <p>Specifies which engines (<code>standard</code> or <code>neural</code>)
266
- * that are supported by a given voice.</p>
267
- */
268
- SupportedEngines?: (Engine | string)[];
269
- }
270
-
271
- export namespace Voice {
272
- /**
273
- * @internal
274
- */
275
- export const filterSensitiveLog = (obj: Voice): any => ({
276
- ...obj,
277
- });
278
- }
279
-
280
- export interface DescribeVoicesOutput {
281
- /**
282
- * <p>A list of voices with their properties.</p>
283
- */
284
- Voices?: Voice[];
285
-
286
- /**
287
- * <p>The pagination token to use in the next request to continue the
288
- * listing of voices. <code>NextToken</code> is returned only if the response
289
- * is truncated.</p>
290
- */
291
- NextToken?: string;
292
- }
293
-
294
- export namespace DescribeVoicesOutput {
295
- /**
296
- * @internal
297
- */
298
- export const filterSensitiveLog = (obj: DescribeVoicesOutput): any => ({
299
- ...obj,
300
- });
301
- }
302
-
303
- /**
304
- * <p>The NextToken is invalid. Verify that it's spelled correctly, and
305
- * then try again.</p>
306
- */
307
- export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
308
- name: "InvalidNextTokenException";
309
- $fault: "client";
310
- message?: string;
311
- }
312
-
313
- export namespace InvalidNextTokenException {
314
- /**
315
- * @internal
316
- */
317
- export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({
318
- ...obj,
319
- });
320
- }
321
-
322
- /**
323
- * <p>This engine is not compatible with the voice that you have designated.
324
- * Choose a new voice that is compatible with the engine or change the engine
325
- * and restart the operation.</p>
326
- */
327
- export interface EngineNotSupportedException extends __SmithyException, $MetadataBearer {
328
- name: "EngineNotSupportedException";
329
- $fault: "client";
330
- message?: string;
331
- }
332
-
333
- export namespace EngineNotSupportedException {
334
- /**
335
- * @internal
336
- */
337
- export const filterSensitiveLog = (obj: EngineNotSupportedException): any => ({
338
- ...obj,
339
- });
340
- }
341
-
342
- export interface GetLexiconInput {
343
- /**
344
- * <p>Name of the lexicon.</p>
345
- */
346
- Name: string | undefined;
347
- }
348
-
349
- export namespace GetLexiconInput {
350
- /**
351
- * @internal
352
- */
353
- export const filterSensitiveLog = (obj: GetLexiconInput): any => ({
354
- ...obj,
355
- });
356
- }
357
-
358
- /**
359
- * <p>Provides lexicon name and lexicon content in string format. For
360
- * more information, see <a href="https://www.w3.org/TR/pronunciation-lexicon/">Pronunciation Lexicon
361
- * Specification (PLS) Version 1.0</a>.</p>
362
- */
363
- export interface Lexicon {
364
- /**
365
- * <p>Lexicon content in string format. The content of a lexicon must be
366
- * in PLS format.</p>
367
- */
368
- Content?: string;
369
-
370
- /**
371
- * <p>Name of the lexicon.</p>
372
- */
373
- Name?: string;
374
- }
375
-
376
- export namespace Lexicon {
377
- /**
378
- * @internal
379
- */
380
- export const filterSensitiveLog = (obj: Lexicon): any => ({
381
- ...obj,
382
- ...(obj.Content && { Content: SENSITIVE_STRING }),
383
- });
384
- }
385
-
386
- /**
387
- * <p>Contains metadata describing the lexicon such as the number of
388
- * 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>
389
- */
390
- export interface LexiconAttributes {
391
- /**
392
- * <p>Phonetic alphabet used in the lexicon. Valid values are
393
- * <code>ipa</code> and <code>x-sampa</code>.</p>
394
- */
395
- Alphabet?: string;
396
-
397
- /**
398
- * <p>Language code that the lexicon applies to. A lexicon with a
399
- * language code such as "en" would be applied to all English languages
400
- * (en-GB, en-US, en-AUS, en-WLS, and so on.</p>
401
- */
402
- LanguageCode?: LanguageCode | string;
403
-
404
- /**
405
- * <p>Date lexicon was last modified (a timestamp value).</p>
406
- */
407
- LastModified?: Date;
408
-
409
- /**
410
- * <p>Amazon Resource Name (ARN) of the lexicon.</p>
411
- */
412
- LexiconArn?: string;
413
-
414
- /**
415
- * <p>Number of lexemes in the lexicon.</p>
416
- */
417
- LexemesCount?: number;
418
-
419
- /**
420
- * <p>Total size of the lexicon, in characters.</p>
421
- */
422
- Size?: number;
423
- }
424
-
425
- export namespace LexiconAttributes {
426
- /**
427
- * @internal
428
- */
429
- export const filterSensitiveLog = (obj: LexiconAttributes): any => ({
430
- ...obj,
431
- });
432
- }
433
-
434
- export interface GetLexiconOutput {
435
- /**
436
- * <p>Lexicon object that provides name and the string content of the
437
- * lexicon. </p>
438
- */
439
- Lexicon?: Lexicon;
440
-
441
- /**
442
- * <p>Metadata of the lexicon, including phonetic alphabetic used,
443
- * language code, lexicon ARN, number of lexemes defined in the lexicon, and
444
- * size of lexicon in bytes.</p>
445
- */
446
- LexiconAttributes?: LexiconAttributes;
447
- }
448
-
449
- export namespace GetLexiconOutput {
450
- /**
451
- * @internal
452
- */
453
- export const filterSensitiveLog = (obj: GetLexiconOutput): any => ({
454
- ...obj,
455
- ...(obj.Lexicon && { Lexicon: Lexicon.filterSensitiveLog(obj.Lexicon) }),
456
- });
457
- }
458
-
459
- export interface GetSpeechSynthesisTaskInput {
460
- /**
461
- * <p>The Amazon Polly generated identifier for a speech synthesis task.</p>
462
- */
463
- TaskId: string | undefined;
464
- }
465
-
466
- export namespace GetSpeechSynthesisTaskInput {
467
- /**
468
- * @internal
469
- */
470
- export const filterSensitiveLog = (obj: GetSpeechSynthesisTaskInput): any => ({
471
- ...obj,
472
- });
473
- }
474
-
475
- export enum OutputFormat {
476
- JSON = "json",
477
- MP3 = "mp3",
478
- OGG_VORBIS = "ogg_vorbis",
479
- PCM = "pcm",
480
- }
481
-
482
- export enum SpeechMarkType {
483
- SENTENCE = "sentence",
484
- SSML = "ssml",
485
- VISEME = "viseme",
486
- WORD = "word",
487
- }
488
-
489
- export enum TaskStatus {
490
- COMPLETED = "completed",
491
- FAILED = "failed",
492
- IN_PROGRESS = "inProgress",
493
- SCHEDULED = "scheduled",
494
- }
495
-
496
- export enum TextType {
497
- SSML = "ssml",
498
- TEXT = "text",
499
- }
500
-
501
- /**
502
- * <p>SynthesisTask object that provides information about a speech
503
- * synthesis task.</p>
504
- */
505
- export interface SynthesisTask {
506
- /**
507
- * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
508
- * for Amazon Polly to use when processing input text for speech synthesis. Using a
509
- * voice that is not supported for the engine selected will result in an
510
- * error.</p>
511
- */
512
- Engine?: Engine | string;
513
-
514
- /**
515
- * <p>The Amazon Polly generated identifier for a speech synthesis task.</p>
516
- */
517
- TaskId?: string;
518
-
519
- /**
520
- * <p>Current status of the individual speech synthesis task.</p>
521
- */
522
- TaskStatus?: TaskStatus | string;
523
-
524
- /**
525
- * <p>Reason for the current status of a specific speech synthesis task,
526
- * including errors if the task has failed.</p>
527
- */
528
- TaskStatusReason?: string;
529
-
530
- /**
531
- * <p>Pathway for the output speech file.</p>
532
- */
533
- OutputUri?: string;
534
-
535
- /**
536
- * <p>Timestamp for the time the synthesis task was started.</p>
537
- */
538
- CreationTime?: Date;
539
-
540
- /**
541
- * <p>Number of billable characters synthesized.</p>
542
- */
543
- RequestCharacters?: number;
544
-
545
- /**
546
- * <p>ARN for the SNS topic optionally used for providing status
547
- * notification for a speech synthesis task.</p>
548
- */
549
- SnsTopicArn?: string;
550
-
551
- /**
552
- * <p>List of one or more pronunciation lexicon names you want the service
553
- * to apply during synthesis. Lexicons are applied only if the language of
554
- * the lexicon is the same as the language of the voice. </p>
555
- */
556
- LexiconNames?: string[];
557
-
558
- /**
559
- * <p>The format in which the returned output will be encoded. For audio
560
- * stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will
561
- * be json. </p>
562
- */
563
- OutputFormat?: OutputFormat | string;
564
-
565
- /**
566
- * <p>The audio frequency specified in Hz.</p>
567
- * <p>The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
568
- * and "24000". The default value for standard voices is "22050". The default
569
- * value for neural voices is "24000".</p>
570
- * <p>Valid values for pcm are "8000" and "16000" The default value is
571
- * "16000". </p>
572
- */
573
- SampleRate?: string;
574
-
575
- /**
576
- * <p>The type of speech marks returned for the input text.</p>
577
- */
578
- SpeechMarkTypes?: (SpeechMarkType | string)[];
579
-
580
- /**
581
- * <p>Specifies whether the input text is plain text or SSML. The default
582
- * value is plain text. </p>
583
- */
584
- TextType?: TextType | string;
585
-
586
- /**
587
- * <p>Voice ID to use for the synthesis. </p>
588
- */
589
- VoiceId?: VoiceId | string;
590
-
591
- /**
592
- * <p>Optional language code for a synthesis task. This is only necessary if
593
- * using a bilingual voice, such as Aditi, which can be used for either
594
- * Indian English (en-IN) or Hindi (hi-IN). </p>
595
- * <p>If a bilingual voice is used and no language code is specified, Amazon Polly
596
- * uses the default language of the bilingual voice. The default language for
597
- * 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>
598
- * parameter. For example, if no language code is specified, Aditi will use
599
- * Indian English rather than Hindi.</p>
600
- */
601
- LanguageCode?: LanguageCode | string;
602
- }
603
-
604
- export namespace SynthesisTask {
605
- /**
606
- * @internal
607
- */
608
- export const filterSensitiveLog = (obj: SynthesisTask): any => ({
609
- ...obj,
610
- });
611
- }
612
-
613
- export interface GetSpeechSynthesisTaskOutput {
614
- /**
615
- * <p>SynthesisTask object that provides information from the requested
616
- * task, including output format, creation time, task status, and so
617
- * on.</p>
618
- */
619
- SynthesisTask?: SynthesisTask;
620
- }
621
-
622
- export namespace GetSpeechSynthesisTaskOutput {
623
- /**
624
- * @internal
625
- */
626
- export const filterSensitiveLog = (obj: GetSpeechSynthesisTaskOutput): any => ({
627
- ...obj,
628
- });
629
- }
630
-
631
- /**
632
- * <p>The provided Task ID is not valid. Please provide a valid Task ID and
633
- * try again.</p>
634
- */
635
- export interface InvalidTaskIdException extends __SmithyException, $MetadataBearer {
636
- name: "InvalidTaskIdException";
637
- $fault: "client";
638
- message?: string;
639
- }
640
-
641
- export namespace InvalidTaskIdException {
642
- /**
643
- * @internal
644
- */
645
- export const filterSensitiveLog = (obj: InvalidTaskIdException): any => ({
646
- ...obj,
647
- });
648
- }
649
-
650
- /**
651
- * <p>The Speech Synthesis task with requested Task ID cannot be
652
- * found.</p>
653
- */
654
- export interface SynthesisTaskNotFoundException extends __SmithyException, $MetadataBearer {
655
- name: "SynthesisTaskNotFoundException";
656
- $fault: "client";
657
- message?: string;
658
- }
659
-
660
- export namespace SynthesisTaskNotFoundException {
661
- /**
662
- * @internal
663
- */
664
- export const filterSensitiveLog = (obj: SynthesisTaskNotFoundException): any => ({
665
- ...obj,
666
- });
667
- }
668
-
669
- /**
670
- * <p>Amazon Polly can't find the specified lexicon. Verify that the lexicon's
671
- * name is spelled correctly, and then try again.</p>
672
- */
673
- export interface InvalidLexiconException extends __SmithyException, $MetadataBearer {
674
- name: "InvalidLexiconException";
675
- $fault: "client";
676
- message?: string;
677
- }
678
-
679
- export namespace InvalidLexiconException {
680
- /**
681
- * @internal
682
- */
683
- export const filterSensitiveLog = (obj: InvalidLexiconException): any => ({
684
- ...obj,
685
- });
686
- }
687
-
688
- /**
689
- * <p>The provided Amazon S3 bucket name is invalid. Please check your input
690
- * with S3 bucket naming requirements and try again.</p>
691
- */
692
- export interface InvalidS3BucketException extends __SmithyException, $MetadataBearer {
693
- name: "InvalidS3BucketException";
694
- $fault: "client";
695
- message?: string;
696
- }
697
-
698
- export namespace InvalidS3BucketException {
699
- /**
700
- * @internal
701
- */
702
- export const filterSensitiveLog = (obj: InvalidS3BucketException): any => ({
703
- ...obj,
704
- });
705
- }
706
-
707
- /**
708
- * <p>The provided Amazon S3 key prefix is invalid. Please provide a valid
709
- * S3 object key name.</p>
710
- */
711
- export interface InvalidS3KeyException extends __SmithyException, $MetadataBearer {
712
- name: "InvalidS3KeyException";
713
- $fault: "client";
714
- message?: string;
715
- }
716
-
717
- export namespace InvalidS3KeyException {
718
- /**
719
- * @internal
720
- */
721
- export const filterSensitiveLog = (obj: InvalidS3KeyException): any => ({
722
- ...obj,
723
- });
724
- }
725
-
726
- /**
727
- * <p>The specified sample rate is not valid.</p>
728
- */
729
- export interface InvalidSampleRateException extends __SmithyException, $MetadataBearer {
730
- name: "InvalidSampleRateException";
731
- $fault: "client";
732
- message?: string;
733
- }
734
-
735
- export namespace InvalidSampleRateException {
736
- /**
737
- * @internal
738
- */
739
- export const filterSensitiveLog = (obj: InvalidSampleRateException): any => ({
740
- ...obj,
741
- });
742
- }
743
-
744
- /**
745
- * <p>The provided SNS topic ARN is invalid. Please provide a valid SNS
746
- * topic ARN and try again.</p>
747
- */
748
- export interface InvalidSnsTopicArnException extends __SmithyException, $MetadataBearer {
749
- name: "InvalidSnsTopicArnException";
750
- $fault: "client";
751
- message?: string;
752
- }
753
-
754
- export namespace InvalidSnsTopicArnException {
755
- /**
756
- * @internal
757
- */
758
- export const filterSensitiveLog = (obj: InvalidSnsTopicArnException): any => ({
759
- ...obj,
760
- });
761
- }
762
-
763
- /**
764
- * <p>The SSML you provided is invalid. Verify the SSML syntax, spelling
765
- * of tags and values, and then try again.</p>
766
- */
767
- export interface InvalidSsmlException extends __SmithyException, $MetadataBearer {
768
- name: "InvalidSsmlException";
769
- $fault: "client";
770
- message?: string;
771
- }
772
-
773
- export namespace InvalidSsmlException {
774
- /**
775
- * @internal
776
- */
777
- export const filterSensitiveLog = (obj: InvalidSsmlException): any => ({
778
- ...obj,
779
- });
780
- }
781
-
782
- /**
783
- * <p>The language specified is not currently supported by Amazon Polly in this
784
- * capacity.</p>
785
- */
786
- export interface LanguageNotSupportedException extends __SmithyException, $MetadataBearer {
787
- name: "LanguageNotSupportedException";
788
- $fault: "client";
789
- message?: string;
790
- }
791
-
792
- export namespace LanguageNotSupportedException {
793
- /**
794
- * @internal
795
- */
796
- export const filterSensitiveLog = (obj: LanguageNotSupportedException): any => ({
797
- ...obj,
798
- });
799
- }
800
-
801
- /**
802
- * <p>Describes the content of the lexicon.</p>
803
- */
804
- export interface LexiconDescription {
805
- /**
806
- * <p>Name of the lexicon.</p>
807
- */
808
- Name?: string;
809
-
810
- /**
811
- * <p>Provides lexicon metadata.</p>
812
- */
813
- Attributes?: LexiconAttributes;
814
- }
815
-
816
- export namespace LexiconDescription {
817
- /**
818
- * @internal
819
- */
820
- export const filterSensitiveLog = (obj: LexiconDescription): any => ({
821
- ...obj,
822
- });
823
- }
824
-
825
- /**
826
- * <p>The maximum size of the specified lexicon would be exceeded by this
827
- * operation.</p>
828
- */
829
- export interface LexiconSizeExceededException extends __SmithyException, $MetadataBearer {
830
- name: "LexiconSizeExceededException";
831
- $fault: "client";
832
- message?: string;
833
- }
834
-
835
- export namespace LexiconSizeExceededException {
836
- /**
837
- * @internal
838
- */
839
- export const filterSensitiveLog = (obj: LexiconSizeExceededException): any => ({
840
- ...obj,
841
- });
842
- }
843
-
844
- export interface ListLexiconsInput {
845
- /**
846
- * <p>An opaque pagination token returned from previous
847
- * <code>ListLexicons</code> operation. If present, indicates where to
848
- * continue the list of lexicons.</p>
849
- */
850
- NextToken?: string;
851
- }
852
-
853
- export namespace ListLexiconsInput {
854
- /**
855
- * @internal
856
- */
857
- export const filterSensitiveLog = (obj: ListLexiconsInput): any => ({
858
- ...obj,
859
- });
860
- }
861
-
862
- export interface ListLexiconsOutput {
863
- /**
864
- * <p>A list of lexicon names and attributes.</p>
865
- */
866
- Lexicons?: LexiconDescription[];
867
-
868
- /**
869
- * <p>The pagination token to use in the next request to continue the
870
- * listing of lexicons. <code>NextToken</code> is returned only if the
871
- * response is truncated.</p>
872
- */
873
- NextToken?: string;
874
- }
875
-
876
- export namespace ListLexiconsOutput {
877
- /**
878
- * @internal
879
- */
880
- export const filterSensitiveLog = (obj: ListLexiconsOutput): any => ({
881
- ...obj,
882
- });
883
- }
884
-
885
- export interface ListSpeechSynthesisTasksInput {
886
- /**
887
- * <p>Maximum number of speech synthesis tasks returned in a List
888
- * operation.</p>
889
- */
890
- MaxResults?: number;
891
-
892
- /**
893
- * <p>The pagination token to use in the next request to continue the
894
- * listing of speech synthesis tasks. </p>
895
- */
896
- NextToken?: string;
897
-
898
- /**
899
- * <p>Status of the speech synthesis tasks returned in a List
900
- * operation</p>
901
- */
902
- Status?: TaskStatus | string;
903
- }
904
-
905
- export namespace ListSpeechSynthesisTasksInput {
906
- /**
907
- * @internal
908
- */
909
- export const filterSensitiveLog = (obj: ListSpeechSynthesisTasksInput): any => ({
910
- ...obj,
911
- });
912
- }
913
-
914
- export interface ListSpeechSynthesisTasksOutput {
915
- /**
916
- * <p>An opaque pagination token returned from the previous List operation
917
- * in this request. If present, this indicates where to continue the
918
- * listing.</p>
919
- */
920
- NextToken?: string;
921
-
922
- /**
923
- * <p>List of SynthesisTask objects that provides information from the
924
- * specified task in the list request, including output format, creation
925
- * time, task status, and so on.</p>
926
- */
927
- SynthesisTasks?: SynthesisTask[];
928
- }
929
-
930
- export namespace ListSpeechSynthesisTasksOutput {
931
- /**
932
- * @internal
933
- */
934
- export const filterSensitiveLog = (obj: ListSpeechSynthesisTasksOutput): any => ({
935
- ...obj,
936
- });
937
- }
938
-
939
- /**
940
- * <p>Speech marks are not supported for the <code>OutputFormat</code>
941
- * selected. Speech marks are only available for content in <code>json</code>
942
- * format.</p>
943
- */
944
- export interface MarksNotSupportedForFormatException extends __SmithyException, $MetadataBearer {
945
- name: "MarksNotSupportedForFormatException";
946
- $fault: "client";
947
- message?: string;
948
- }
949
-
950
- export namespace MarksNotSupportedForFormatException {
951
- /**
952
- * @internal
953
- */
954
- export const filterSensitiveLog = (obj: MarksNotSupportedForFormatException): any => ({
955
- ...obj,
956
- });
957
- }
958
-
959
- /**
960
- * <p>The maximum size of the lexeme would be exceeded by this
961
- * operation.</p>
962
- */
963
- export interface MaxLexemeLengthExceededException extends __SmithyException, $MetadataBearer {
964
- name: "MaxLexemeLengthExceededException";
965
- $fault: "client";
966
- message?: string;
967
- }
968
-
969
- export namespace MaxLexemeLengthExceededException {
970
- /**
971
- * @internal
972
- */
973
- export const filterSensitiveLog = (obj: MaxLexemeLengthExceededException): any => ({
974
- ...obj,
975
- });
976
- }
977
-
978
- /**
979
- * <p>The maximum number of lexicons would be exceeded by this
980
- * operation.</p>
981
- */
982
- export interface MaxLexiconsNumberExceededException extends __SmithyException, $MetadataBearer {
983
- name: "MaxLexiconsNumberExceededException";
984
- $fault: "client";
985
- message?: string;
986
- }
987
-
988
- export namespace MaxLexiconsNumberExceededException {
989
- /**
990
- * @internal
991
- */
992
- export const filterSensitiveLog = (obj: MaxLexiconsNumberExceededException): any => ({
993
- ...obj,
994
- });
995
- }
996
-
997
- export interface PutLexiconInput {
998
- /**
999
- * <p>Name of the lexicon. The name must follow the regular express
1000
- * format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive
1001
- * alphanumeric string up to 20 characters long. </p>
1002
- */
1003
- Name: string | undefined;
1004
-
1005
- /**
1006
- * <p>Content of the PLS lexicon as string data.</p>
1007
- */
1008
- Content: string | undefined;
1009
- }
1010
-
1011
- export namespace PutLexiconInput {
1012
- /**
1013
- * @internal
1014
- */
1015
- export const filterSensitiveLog = (obj: PutLexiconInput): any => ({
1016
- ...obj,
1017
- ...(obj.Content && { Content: SENSITIVE_STRING }),
1018
- });
1019
- }
1020
-
1021
- export interface PutLexiconOutput {}
1022
-
1023
- export namespace PutLexiconOutput {
1024
- /**
1025
- * @internal
1026
- */
1027
- export const filterSensitiveLog = (obj: PutLexiconOutput): any => ({
1028
- ...obj,
1029
- });
1030
- }
1031
-
1032
- /**
1033
- * <p>The alphabet specified by the lexicon is not a supported alphabet.
1034
- * Valid values are <code>x-sampa</code> and <code>ipa</code>.</p>
1035
- */
1036
- export interface UnsupportedPlsAlphabetException extends __SmithyException, $MetadataBearer {
1037
- name: "UnsupportedPlsAlphabetException";
1038
- $fault: "client";
1039
- message?: string;
1040
- }
1041
-
1042
- export namespace UnsupportedPlsAlphabetException {
1043
- /**
1044
- * @internal
1045
- */
1046
- export const filterSensitiveLog = (obj: UnsupportedPlsAlphabetException): any => ({
1047
- ...obj,
1048
- });
1049
- }
1050
-
1051
- /**
1052
- * <p>The language specified in the lexicon is unsupported. For a list of
1053
- * supported languages, see <a href="https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html">Lexicon Attributes</a>.</p>
1054
- */
1055
- export interface UnsupportedPlsLanguageException extends __SmithyException, $MetadataBearer {
1056
- name: "UnsupportedPlsLanguageException";
1057
- $fault: "client";
1058
- message?: string;
1059
- }
1060
-
1061
- export namespace UnsupportedPlsLanguageException {
1062
- /**
1063
- * @internal
1064
- */
1065
- export const filterSensitiveLog = (obj: UnsupportedPlsLanguageException): any => ({
1066
- ...obj,
1067
- });
1068
- }
1069
-
1070
- /**
1071
- * <p>SSML speech marks are not supported for plain text-type
1072
- * input.</p>
1073
- */
1074
- export interface SsmlMarksNotSupportedForTextTypeException extends __SmithyException, $MetadataBearer {
1075
- name: "SsmlMarksNotSupportedForTextTypeException";
1076
- $fault: "client";
1077
- message?: string;
1078
- }
1079
-
1080
- export namespace SsmlMarksNotSupportedForTextTypeException {
1081
- /**
1082
- * @internal
1083
- */
1084
- export const filterSensitiveLog = (obj: SsmlMarksNotSupportedForTextTypeException): any => ({
1085
- ...obj,
1086
- });
1087
- }
1088
-
1089
- export interface StartSpeechSynthesisTaskInput {
1090
- /**
1091
- * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
1092
- * for Amazon Polly to use when processing input text for speech synthesis. Using a
1093
- * voice that is not supported for the engine selected will result in an
1094
- * error.</p>
1095
- */
1096
- Engine?: Engine | string;
1097
-
1098
- /**
1099
- * <p>Optional language code for the Speech Synthesis request. This is only
1100
- * necessary if using a bilingual voice, such as Aditi, which can be used for
1101
- * either Indian English (en-IN) or Hindi (hi-IN). </p>
1102
- * <p>If a bilingual voice is used and no language code is specified, Amazon Polly
1103
- * uses the default language of the bilingual voice. The default language for
1104
- * 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>
1105
- * parameter. For example, if no language code is specified, Aditi will use
1106
- * Indian English rather than Hindi.</p>
1107
- */
1108
- LanguageCode?: LanguageCode | string;
1109
-
1110
- /**
1111
- * <p>List of one or more pronunciation lexicon names you want the service
1112
- * to apply during synthesis. Lexicons are applied only if the language of
1113
- * the lexicon is the same as the language of the voice. </p>
1114
- */
1115
- LexiconNames?: string[];
1116
-
1117
- /**
1118
- * <p>The format in which the returned output will be encoded. For audio
1119
- * stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will
1120
- * be json. </p>
1121
- */
1122
- OutputFormat: OutputFormat | string | undefined;
1123
-
1124
- /**
1125
- * <p>Amazon S3 bucket name to which the output file will be saved.</p>
1126
- */
1127
- OutputS3BucketName: string | undefined;
1128
-
1129
- /**
1130
- * <p>The Amazon S3 key prefix for the output speech file.</p>
1131
- */
1132
- OutputS3KeyPrefix?: string;
1133
-
1134
- /**
1135
- * <p>The audio frequency specified in Hz.</p>
1136
- * <p>The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
1137
- * and "24000". The default value for standard voices is "22050". The default
1138
- * value for neural voices is "24000".</p>
1139
- * <p>Valid values for pcm are "8000" and "16000" The default value is
1140
- * "16000". </p>
1141
- */
1142
- SampleRate?: string;
1143
-
1144
- /**
1145
- * <p>ARN for the SNS topic optionally used for providing status
1146
- * notification for a speech synthesis task.</p>
1147
- */
1148
- SnsTopicArn?: string;
1149
-
1150
- /**
1151
- * <p>The type of speech marks returned for the input text.</p>
1152
- */
1153
- SpeechMarkTypes?: (SpeechMarkType | string)[];
1154
-
1155
- /**
1156
- * <p>The input text to synthesize. If you specify ssml as the TextType,
1157
- * follow the SSML format for the input text. </p>
1158
- */
1159
- Text: string | undefined;
1160
-
1161
- /**
1162
- * <p>Specifies whether the input text is plain text or SSML. The default
1163
- * value is plain text. </p>
1164
- */
1165
- TextType?: TextType | string;
1166
-
1167
- /**
1168
- * <p>Voice ID to use for the synthesis. </p>
1169
- */
1170
- VoiceId: VoiceId | string | undefined;
1171
- }
1172
-
1173
- export namespace StartSpeechSynthesisTaskInput {
1174
- /**
1175
- * @internal
1176
- */
1177
- export const filterSensitiveLog = (obj: StartSpeechSynthesisTaskInput): any => ({
1178
- ...obj,
1179
- });
1180
- }
1181
-
1182
- export interface StartSpeechSynthesisTaskOutput {
1183
- /**
1184
- * <p>SynthesisTask object that provides information and attributes about a
1185
- * newly submitted speech synthesis task.</p>
1186
- */
1187
- SynthesisTask?: SynthesisTask;
1188
- }
1189
-
1190
- export namespace StartSpeechSynthesisTaskOutput {
1191
- /**
1192
- * @internal
1193
- */
1194
- export const filterSensitiveLog = (obj: StartSpeechSynthesisTaskOutput): any => ({
1195
- ...obj,
1196
- });
1197
- }
1198
-
1199
- /**
1200
- * <p>The value of the "Text" parameter is longer than the accepted
1201
- * limits. For the <code>SynthesizeSpeech</code> API, the limit for input
1202
- * text is a maximum of 6000 characters total, of which no more than 3000 can
1203
- * be billed characters. For the <code>StartSpeechSynthesisTask</code> API,
1204
- * the maximum is 200,000 characters, of which no more than 100,000 can be
1205
- * billed characters. SSML tags are not counted as billed
1206
- * characters.</p>
1207
- */
1208
- export interface TextLengthExceededException extends __SmithyException, $MetadataBearer {
1209
- name: "TextLengthExceededException";
1210
- $fault: "client";
1211
- message?: string;
1212
- }
1213
-
1214
- export namespace TextLengthExceededException {
1215
- /**
1216
- * @internal
1217
- */
1218
- export const filterSensitiveLog = (obj: TextLengthExceededException): any => ({
1219
- ...obj,
1220
- });
1221
- }
1222
-
1223
- export interface SynthesizeSpeechInput {
1224
- /**
1225
- * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
1226
- * for Amazon Polly to use when processing input text for speech synthesis. For
1227
- * information on Amazon Polly voices and which voices are available in
1228
- * 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>
1229
- * <p>
1230
- * <b>NTTS-only voices</b>
1231
- * </p>
1232
- * <p>When using NTTS-only voices such as Kevin (en-US), this parameter is
1233
- * required and must be set to <code>neural</code>. If the engine is not
1234
- * specified, or is set to <code>standard</code>, this will result in an
1235
- * error. </p>
1236
- * <p>Type: String</p>
1237
- * <p>Valid Values: <code>standard</code> | <code>neural</code>
1238
- * </p>
1239
- * <p>Required: Yes</p>
1240
- *
1241
- * <p>
1242
- * <b>Standard voices</b>
1243
- * </p>
1244
- * <p>For standard voices, this is not required; the engine parameter
1245
- * defaults to <code>standard</code>. If the engine is not specified, or is
1246
- * set to <code>standard</code> and an NTTS-only voice is selected, this will
1247
- * result in an error. </p>
1248
- */
1249
- Engine?: Engine | string;
1250
-
1251
- /**
1252
- * <p>Optional language code for the Synthesize Speech request. This is only
1253
- * necessary if using a bilingual voice, such as Aditi, which can be used for
1254
- * either Indian English (en-IN) or Hindi (hi-IN). </p>
1255
- * <p>If a bilingual voice is used and no language code is specified, Amazon Polly
1256
- * uses the default language of the bilingual voice. The default language for
1257
- * 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>
1258
- * parameter. For example, if no language code is specified, Aditi will use
1259
- * Indian English rather than Hindi.</p>
1260
- */
1261
- LanguageCode?: LanguageCode | string;
1262
-
1263
- /**
1264
- * <p>List of one or more pronunciation lexicon names you want the
1265
- * service to apply during synthesis. Lexicons are applied only if the
1266
- * language of the lexicon is the same as the language of the voice. For
1267
- * information about storing lexicons, see <a href="https://docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html">PutLexicon</a>.</p>
1268
- */
1269
- LexiconNames?: string[];
1270
-
1271
- /**
1272
- * <p> The format in which the returned output will be encoded. For audio
1273
- * stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will
1274
- * be json. </p>
1275
- * <p>When pcm is used, the content returned is audio/pcm in a signed
1276
- * 16-bit, 1 channel (mono), little-endian format. </p>
1277
- */
1278
- OutputFormat: OutputFormat | string | undefined;
1279
-
1280
- /**
1281
- * <p>The audio frequency specified in Hz.</p>
1282
- * <p>The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
1283
- * and "24000". The default value for standard voices is "22050". The default
1284
- * value for neural voices is "24000".</p>
1285
- * <p>Valid values for pcm are "8000" and "16000" The default value is
1286
- * "16000". </p>
1287
- */
1288
- SampleRate?: string;
1289
-
1290
- /**
1291
- * <p>The type of speech marks returned for the input text.</p>
1292
- */
1293
- SpeechMarkTypes?: (SpeechMarkType | string)[];
1294
-
1295
- /**
1296
- * <p> Input text to synthesize. If you specify <code>ssml</code> as the
1297
- * <code>TextType</code>, follow the SSML format for the input text.
1298
- * </p>
1299
- */
1300
- Text: string | undefined;
1301
-
1302
- /**
1303
- * <p> Specifies whether the input text is plain text or SSML. The
1304
- * default value is plain text. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/ssml.html">Using
1305
- * SSML</a>.</p>
1306
- */
1307
- TextType?: TextType | string;
1308
-
1309
- /**
1310
- * <p> Voice ID to use for the synthesis. You can get a list of available
1311
- * voice IDs by calling the <a href="https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html">DescribeVoices</a> operation. </p>
1312
- */
1313
- VoiceId: VoiceId | string | undefined;
1314
- }
1315
-
1316
- export namespace SynthesizeSpeechInput {
1317
- /**
1318
- * @internal
1319
- */
1320
- export const filterSensitiveLog = (obj: SynthesizeSpeechInput): any => ({
1321
- ...obj,
1322
- });
1323
- }
1324
-
1325
- export interface SynthesizeSpeechOutput {
1326
- /**
1327
- * <p> Stream containing the synthesized speech. </p>
1328
- */
1329
- AudioStream?: Readable | ReadableStream | Blob;
1330
-
1331
- /**
1332
- * <p> Specifies the type audio stream. This should reflect the
1333
- * <code>OutputFormat</code> parameter in your request. </p>
1334
- * <ul>
1335
- * <li>
1336
- * <p> If you request <code>mp3</code> as the
1337
- * <code>OutputFormat</code>, the <code>ContentType</code> returned is
1338
- * audio/mpeg. </p>
1339
- * </li>
1340
- * <li>
1341
- * <p> If you request <code>ogg_vorbis</code> as the
1342
- * <code>OutputFormat</code>, the <code>ContentType</code> returned is
1343
- * audio/ogg. </p>
1344
- * </li>
1345
- * <li>
1346
- * <p> If you request <code>pcm</code> as the
1347
- * <code>OutputFormat</code>, the <code>ContentType</code> returned is
1348
- * audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
1349
- * </p>
1350
- * </li>
1351
- * <li>
1352
- * <p>If you request <code>json</code> as the
1353
- * <code>OutputFormat</code>, the <code>ContentType</code> returned is
1354
- * audio/json.</p>
1355
- * </li>
1356
- * </ul>
1357
- * <p> </p>
1358
- */
1359
- ContentType?: string;
1360
-
1361
- /**
1362
- * <p>Number of characters synthesized.</p>
1363
- */
1364
- RequestCharacters?: number;
1365
- }
1366
-
1367
- export namespace SynthesizeSpeechOutput {
1368
- /**
1369
- * @internal
1370
- */
1371
- export const filterSensitiveLog = (obj: SynthesizeSpeechOutput): any => ({
1372
- ...obj,
1373
- });
1374
- }