@aws-sdk/client-polly 3.529.1 → 3.535.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 (31) hide show
  1. package/dist-types/Polly.d.ts +4 -1
  2. package/dist-types/PollyClient.d.ts +1 -1
  3. package/dist-types/commands/DeleteLexiconCommand.d.ts +2 -1
  4. package/dist-types/commands/DescribeVoicesCommand.d.ts +2 -1
  5. package/dist-types/commands/GetLexiconCommand.d.ts +2 -1
  6. package/dist-types/commands/GetSpeechSynthesisTaskCommand.d.ts +2 -1
  7. package/dist-types/commands/ListLexiconsCommand.d.ts +2 -1
  8. package/dist-types/commands/ListSpeechSynthesisTasksCommand.d.ts +2 -1
  9. package/dist-types/commands/PutLexiconCommand.d.ts +2 -1
  10. package/dist-types/commands/StartSpeechSynthesisTaskCommand.d.ts +2 -1
  11. package/dist-types/commands/SynthesizeSpeechCommand.d.ts +3 -2
  12. package/dist-types/models/models_0.d.ts +105 -105
  13. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  14. package/dist-types/runtimeConfig.d.ts +2 -2
  15. package/dist-types/runtimeConfig.native.d.ts +2 -2
  16. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  17. package/dist-types/ts3.4/Polly.d.ts +3 -0
  18. package/dist-types/ts3.4/commands/DeleteLexiconCommand.d.ts +9 -0
  19. package/dist-types/ts3.4/commands/DescribeVoicesCommand.d.ts +9 -0
  20. package/dist-types/ts3.4/commands/GetLexiconCommand.d.ts +9 -0
  21. package/dist-types/ts3.4/commands/GetSpeechSynthesisTaskCommand.d.ts +9 -0
  22. package/dist-types/ts3.4/commands/ListLexiconsCommand.d.ts +9 -0
  23. package/dist-types/ts3.4/commands/ListSpeechSynthesisTasksCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/PutLexiconCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/StartSpeechSynthesisTaskCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/SynthesizeSpeechCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  28. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  29. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  30. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  31. package/package.json +41 -41
@@ -6,9 +6,9 @@ import { PollyServiceException as __BaseException } from "./PollyServiceExceptio
6
6
  */
7
7
  export interface DeleteLexiconInput {
8
8
  /**
9
- * @public
10
9
  * <p>The name of the lexicon to delete. Must be an existing lexicon in
11
10
  * the region.</p>
11
+ * @public
12
12
  */
13
13
  Name: string | undefined;
14
14
  }
@@ -18,12 +18,12 @@ export interface DeleteLexiconInput {
18
18
  export interface DeleteLexiconOutput {
19
19
  }
20
20
  /**
21
- * @public
22
21
  * <p>Amazon Polly can't find the specified lexicon. This could be caused by a
23
22
  * lexicon that is missing, its name is misspelled or specifying a lexicon
24
23
  * that is in a different region.</p>
25
24
  * <p>Verify that the lexicon exists, is in the region (see <a>ListLexicons</a>) and that you spelled its name is spelled
26
25
  * correctly. Then try again.</p>
26
+ * @public
27
27
  */
28
28
  export declare class LexiconNotFoundException extends __BaseException {
29
29
  readonly name: "LexiconNotFoundException";
@@ -34,8 +34,8 @@ export declare class LexiconNotFoundException extends __BaseException {
34
34
  constructor(opts: __ExceptionOptionType<LexiconNotFoundException, __BaseException>);
35
35
  }
36
36
  /**
37
- * @public
38
37
  * <p>An unknown condition has caused a service failure.</p>
38
+ * @public
39
39
  */
40
40
  export declare class ServiceFailureException extends __BaseException {
41
41
  readonly name: "ServiceFailureException";
@@ -112,35 +112,35 @@ export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
112
112
  */
113
113
  export interface DescribeVoicesInput {
114
114
  /**
115
- * @public
116
115
  * <p>Specifies the engine (<code>standard</code>, <code>neural</code> or
117
116
  * <code>long-form</code>) used by Amazon Polly when processing input text for
118
117
  * speech synthesis. </p>
118
+ * @public
119
119
  */
120
120
  Engine?: Engine;
121
121
  /**
122
- * @public
123
122
  * <p> The language identification tag (ISO 639 code for the language
124
123
  * name-ISO 3166 country code) for filtering the list of voices returned. If
125
124
  * you don't specify this optional parameter, all available voices are
126
125
  * returned. </p>
126
+ * @public
127
127
  */
128
128
  LanguageCode?: LanguageCode;
129
129
  /**
130
- * @public
131
130
  * <p>Boolean value indicating whether to return any bilingual voices that
132
131
  * use the specified language as an additional language. For instance, if you
133
132
  * request all languages that use US English (es-US), and there is an Italian
134
133
  * voice that speaks both Italian (it-IT) and US English, that voice will be
135
134
  * included if you specify <code>yes</code> but not if you specify
136
135
  * <code>no</code>.</p>
136
+ * @public
137
137
  */
138
138
  IncludeAdditionalLanguageCodes?: boolean;
139
139
  /**
140
- * @public
141
140
  * <p>An opaque pagination token returned from the previous
142
141
  * <code>DescribeVoices</code> operation. If present, this indicates where
143
142
  * to continue the listing.</p>
143
+ * @public
144
144
  */
145
145
  NextToken?: string;
146
146
  }
@@ -263,52 +263,52 @@ export declare const VoiceId: {
263
263
  */
264
264
  export type VoiceId = (typeof VoiceId)[keyof typeof VoiceId];
265
265
  /**
266
- * @public
267
266
  * <p>Description of the voice.</p>
267
+ * @public
268
268
  */
269
269
  export interface Voice {
270
270
  /**
271
- * @public
272
271
  * <p>Gender of the voice.</p>
272
+ * @public
273
273
  */
274
274
  Gender?: Gender;
275
275
  /**
276
- * @public
277
276
  * <p>Amazon Polly assigned voice ID. This is the ID that you specify when
278
277
  * calling the <code>SynthesizeSpeech</code> operation.</p>
278
+ * @public
279
279
  */
280
280
  Id?: VoiceId;
281
281
  /**
282
- * @public
283
282
  * <p>Language code of the voice.</p>
283
+ * @public
284
284
  */
285
285
  LanguageCode?: LanguageCode;
286
286
  /**
287
- * @public
288
287
  * <p>Human readable name of the language in English.</p>
288
+ * @public
289
289
  */
290
290
  LanguageName?: string;
291
291
  /**
292
- * @public
293
292
  * <p>Name of the voice (for example, Salli, Kendra, etc.). This provides
294
293
  * a human readable voice name that you might display in your
295
294
  * application.</p>
295
+ * @public
296
296
  */
297
297
  Name?: string;
298
298
  /**
299
- * @public
300
299
  * <p>Additional codes for languages available for the specified voice in
301
300
  * addition to its default language. </p>
302
301
  * <p>For example, the default language for Aditi is Indian English (en-IN)
303
302
  * because it was first used for that language. Since Aditi is bilingual and
304
303
  * fluent in both Indian English and Hindi, this parameter would show the
305
304
  * code <code>hi-IN</code>.</p>
305
+ * @public
306
306
  */
307
307
  AdditionalLanguageCodes?: LanguageCode[];
308
308
  /**
309
- * @public
310
309
  * <p>Specifies which engines (<code>standard</code>, <code>neural</code> or
311
310
  * <code>long-form</code>) are supported by a given voice.</p>
311
+ * @public
312
312
  */
313
313
  SupportedEngines?: Engine[];
314
314
  }
@@ -317,22 +317,22 @@ export interface Voice {
317
317
  */
318
318
  export interface DescribeVoicesOutput {
319
319
  /**
320
- * @public
321
320
  * <p>A list of voices with their properties.</p>
321
+ * @public
322
322
  */
323
323
  Voices?: Voice[];
324
324
  /**
325
- * @public
326
325
  * <p>The pagination token to use in the next request to continue the
327
326
  * listing of voices. <code>NextToken</code> is returned only if the response
328
327
  * is truncated.</p>
328
+ * @public
329
329
  */
330
330
  NextToken?: string;
331
331
  }
332
332
  /**
333
- * @public
334
333
  * <p>The NextToken is invalid. Verify that it's spelled correctly, and
335
334
  * then try again.</p>
335
+ * @public
336
336
  */
337
337
  export declare class InvalidNextTokenException extends __BaseException {
338
338
  readonly name: "InvalidNextTokenException";
@@ -343,10 +343,10 @@ export declare class InvalidNextTokenException extends __BaseException {
343
343
  constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
344
344
  }
345
345
  /**
346
- * @public
347
346
  * <p>This engine is not compatible with the voice that you have designated.
348
347
  * Choose a new voice that is compatible with the engine or change the engine
349
348
  * and restart the operation.</p>
349
+ * @public
350
350
  */
351
351
  export declare class EngineNotSupportedException extends __BaseException {
352
352
  readonly name: "EngineNotSupportedException";
@@ -361,67 +361,67 @@ export declare class EngineNotSupportedException extends __BaseException {
361
361
  */
362
362
  export interface GetLexiconInput {
363
363
  /**
364
- * @public
365
364
  * <p>Name of the lexicon.</p>
365
+ * @public
366
366
  */
367
367
  Name: string | undefined;
368
368
  }
369
369
  /**
370
- * @public
371
370
  * <p>Provides lexicon name and lexicon content in string format. For
372
371
  * more information, see <a href="https://www.w3.org/TR/pronunciation-lexicon/">Pronunciation Lexicon
373
372
  * Specification (PLS) Version 1.0</a>.</p>
373
+ * @public
374
374
  */
375
375
  export interface Lexicon {
376
376
  /**
377
- * @public
378
377
  * <p>Lexicon content in string format. The content of a lexicon must be
379
378
  * in PLS format.</p>
379
+ * @public
380
380
  */
381
381
  Content?: string;
382
382
  /**
383
- * @public
384
383
  * <p>Name of the lexicon.</p>
384
+ * @public
385
385
  */
386
386
  Name?: string;
387
387
  }
388
388
  /**
389
- * @public
390
389
  * <p>Contains metadata describing the lexicon such as the number of
391
390
  * 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>
391
+ * @public
392
392
  */
393
393
  export interface LexiconAttributes {
394
394
  /**
395
- * @public
396
395
  * <p>Phonetic alphabet used in the lexicon. Valid values are
397
396
  * <code>ipa</code> and <code>x-sampa</code>.</p>
397
+ * @public
398
398
  */
399
399
  Alphabet?: string;
400
400
  /**
401
- * @public
402
401
  * <p>Language code that the lexicon applies to. A lexicon with a
403
402
  * language code such as "en" would be applied to all English languages
404
403
  * (en-GB, en-US, en-AUS, en-WLS, and so on.</p>
404
+ * @public
405
405
  */
406
406
  LanguageCode?: LanguageCode;
407
407
  /**
408
- * @public
409
408
  * <p>Date lexicon was last modified (a timestamp value).</p>
409
+ * @public
410
410
  */
411
411
  LastModified?: Date;
412
412
  /**
413
- * @public
414
413
  * <p>Amazon Resource Name (ARN) of the lexicon.</p>
414
+ * @public
415
415
  */
416
416
  LexiconArn?: string;
417
417
  /**
418
- * @public
419
418
  * <p>Number of lexemes in the lexicon.</p>
419
+ * @public
420
420
  */
421
421
  LexemesCount?: number;
422
422
  /**
423
- * @public
424
423
  * <p>Total size of the lexicon, in characters.</p>
424
+ * @public
425
425
  */
426
426
  Size?: number;
427
427
  }
@@ -430,16 +430,16 @@ export interface LexiconAttributes {
430
430
  */
431
431
  export interface GetLexiconOutput {
432
432
  /**
433
- * @public
434
433
  * <p>Lexicon object that provides name and the string content of the
435
434
  * lexicon. </p>
435
+ * @public
436
436
  */
437
437
  Lexicon?: Lexicon;
438
438
  /**
439
- * @public
440
439
  * <p>Metadata of the lexicon, including phonetic alphabetic used,
441
440
  * language code, lexicon ARN, number of lexemes defined in the lexicon, and
442
441
  * size of lexicon in bytes.</p>
442
+ * @public
443
443
  */
444
444
  LexiconAttributes?: LexiconAttributes;
445
445
  }
@@ -448,8 +448,8 @@ export interface GetLexiconOutput {
448
448
  */
449
449
  export interface GetSpeechSynthesisTaskInput {
450
450
  /**
451
- * @public
452
451
  * <p>The Amazon Polly generated identifier for a speech synthesis task.</p>
452
+ * @public
453
453
  */
454
454
  TaskId: string | undefined;
455
455
  }
@@ -508,72 +508,71 @@ export declare const TextType: {
508
508
  */
509
509
  export type TextType = (typeof TextType)[keyof typeof TextType];
510
510
  /**
511
- * @public
512
511
  * <p>SynthesisTask object that provides information about a speech
513
512
  * synthesis task.</p>
513
+ * @public
514
514
  */
515
515
  export interface SynthesisTask {
516
516
  /**
517
- * @public
518
517
  * <p>Specifies the engine (<code>standard</code>, <code>neural</code> or
519
518
  * <code>long-form</code>) for Amazon Polly to use when processing input text for
520
519
  * speech synthesis. Using a voice that is not supported for the engine
521
520
  * selected will result in an error.</p>
521
+ * @public
522
522
  */
523
523
  Engine?: Engine;
524
524
  /**
525
- * @public
526
525
  * <p>The Amazon Polly generated identifier for a speech synthesis task.</p>
526
+ * @public
527
527
  */
528
528
  TaskId?: string;
529
529
  /**
530
- * @public
531
530
  * <p>Current status of the individual speech synthesis task.</p>
531
+ * @public
532
532
  */
533
533
  TaskStatus?: TaskStatus;
534
534
  /**
535
- * @public
536
535
  * <p>Reason for the current status of a specific speech synthesis task,
537
536
  * including errors if the task has failed.</p>
537
+ * @public
538
538
  */
539
539
  TaskStatusReason?: string;
540
540
  /**
541
- * @public
542
541
  * <p>Pathway for the output speech file.</p>
542
+ * @public
543
543
  */
544
544
  OutputUri?: string;
545
545
  /**
546
- * @public
547
546
  * <p>Timestamp for the time the synthesis task was started.</p>
547
+ * @public
548
548
  */
549
549
  CreationTime?: Date;
550
550
  /**
551
- * @public
552
551
  * <p>Number of billable characters synthesized.</p>
552
+ * @public
553
553
  */
554
554
  RequestCharacters?: number;
555
555
  /**
556
- * @public
557
556
  * <p>ARN for the SNS topic optionally used for providing status
558
557
  * notification for a speech synthesis task.</p>
558
+ * @public
559
559
  */
560
560
  SnsTopicArn?: string;
561
561
  /**
562
- * @public
563
562
  * <p>List of one or more pronunciation lexicon names you want the service
564
563
  * to apply during synthesis. Lexicons are applied only if the language of
565
564
  * the lexicon is the same as the language of the voice. </p>
565
+ * @public
566
566
  */
567
567
  LexiconNames?: string[];
568
568
  /**
569
- * @public
570
569
  * <p>The format in which the returned output will be encoded. For audio
571
570
  * stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will
572
571
  * be json. </p>
572
+ * @public
573
573
  */
574
574
  OutputFormat?: OutputFormat;
575
575
  /**
576
- * @public
577
576
  * <p>The audio frequency specified in Hz.</p>
578
577
  * <p>The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
579
578
  * and "24000". The default value for standard voices is "22050". The default
@@ -581,26 +580,26 @@ export interface SynthesisTask {
581
580
  * is "24000".</p>
582
581
  * <p>Valid values for pcm are "8000" and "16000" The default value is
583
582
  * "16000". </p>
583
+ * @public
584
584
  */
585
585
  SampleRate?: string;
586
586
  /**
587
- * @public
588
587
  * <p>The type of speech marks returned for the input text.</p>
588
+ * @public
589
589
  */
590
590
  SpeechMarkTypes?: SpeechMarkType[];
591
591
  /**
592
- * @public
593
592
  * <p>Specifies whether the input text is plain text or SSML. The default
594
593
  * value is plain text. </p>
594
+ * @public
595
595
  */
596
596
  TextType?: TextType;
597
597
  /**
598
- * @public
599
598
  * <p>Voice ID to use for the synthesis. </p>
599
+ * @public
600
600
  */
601
601
  VoiceId?: VoiceId;
602
602
  /**
603
- * @public
604
603
  * <p>Optional language code for a synthesis task. This is only necessary if
605
604
  * using a bilingual voice, such as Aditi, which can be used for either
606
605
  * Indian English (en-IN) or Hindi (hi-IN). </p>
@@ -609,6 +608,7 @@ export interface SynthesisTask {
609
608
  * 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>
610
609
  * parameter. For example, if no language code is specified, Aditi will use
611
610
  * Indian English rather than Hindi.</p>
611
+ * @public
612
612
  */
613
613
  LanguageCode?: LanguageCode;
614
614
  }
@@ -617,17 +617,17 @@ export interface SynthesisTask {
617
617
  */
618
618
  export interface GetSpeechSynthesisTaskOutput {
619
619
  /**
620
- * @public
621
620
  * <p>SynthesisTask object that provides information from the requested
622
621
  * task, including output format, creation time, task status, and so
623
622
  * on.</p>
623
+ * @public
624
624
  */
625
625
  SynthesisTask?: SynthesisTask;
626
626
  }
627
627
  /**
628
- * @public
629
628
  * <p>The provided Task ID is not valid. Please provide a valid Task ID and
630
629
  * try again.</p>
630
+ * @public
631
631
  */
632
632
  export declare class InvalidTaskIdException extends __BaseException {
633
633
  readonly name: "InvalidTaskIdException";
@@ -638,9 +638,9 @@ export declare class InvalidTaskIdException extends __BaseException {
638
638
  constructor(opts: __ExceptionOptionType<InvalidTaskIdException, __BaseException>);
639
639
  }
640
640
  /**
641
- * @public
642
641
  * <p>The Speech Synthesis task with requested Task ID cannot be
643
642
  * found.</p>
643
+ * @public
644
644
  */
645
645
  export declare class SynthesisTaskNotFoundException extends __BaseException {
646
646
  readonly name: "SynthesisTaskNotFoundException";
@@ -651,9 +651,9 @@ export declare class SynthesisTaskNotFoundException extends __BaseException {
651
651
  constructor(opts: __ExceptionOptionType<SynthesisTaskNotFoundException, __BaseException>);
652
652
  }
653
653
  /**
654
- * @public
655
654
  * <p>Amazon Polly can't find the specified lexicon. Verify that the lexicon's
656
655
  * name is spelled correctly, and then try again.</p>
656
+ * @public
657
657
  */
658
658
  export declare class InvalidLexiconException extends __BaseException {
659
659
  readonly name: "InvalidLexiconException";
@@ -664,9 +664,9 @@ export declare class InvalidLexiconException extends __BaseException {
664
664
  constructor(opts: __ExceptionOptionType<InvalidLexiconException, __BaseException>);
665
665
  }
666
666
  /**
667
- * @public
668
667
  * <p>The provided Amazon S3 bucket name is invalid. Please check your input
669
668
  * with S3 bucket naming requirements and try again.</p>
669
+ * @public
670
670
  */
671
671
  export declare class InvalidS3BucketException extends __BaseException {
672
672
  readonly name: "InvalidS3BucketException";
@@ -677,9 +677,9 @@ export declare class InvalidS3BucketException extends __BaseException {
677
677
  constructor(opts: __ExceptionOptionType<InvalidS3BucketException, __BaseException>);
678
678
  }
679
679
  /**
680
- * @public
681
680
  * <p>The provided Amazon S3 key prefix is invalid. Please provide a valid
682
681
  * S3 object key name.</p>
682
+ * @public
683
683
  */
684
684
  export declare class InvalidS3KeyException extends __BaseException {
685
685
  readonly name: "InvalidS3KeyException";
@@ -690,8 +690,8 @@ export declare class InvalidS3KeyException extends __BaseException {
690
690
  constructor(opts: __ExceptionOptionType<InvalidS3KeyException, __BaseException>);
691
691
  }
692
692
  /**
693
- * @public
694
693
  * <p>The specified sample rate is not valid.</p>
694
+ * @public
695
695
  */
696
696
  export declare class InvalidSampleRateException extends __BaseException {
697
697
  readonly name: "InvalidSampleRateException";
@@ -702,9 +702,9 @@ export declare class InvalidSampleRateException extends __BaseException {
702
702
  constructor(opts: __ExceptionOptionType<InvalidSampleRateException, __BaseException>);
703
703
  }
704
704
  /**
705
- * @public
706
705
  * <p>The provided SNS topic ARN is invalid. Please provide a valid SNS
707
706
  * topic ARN and try again.</p>
707
+ * @public
708
708
  */
709
709
  export declare class InvalidSnsTopicArnException extends __BaseException {
710
710
  readonly name: "InvalidSnsTopicArnException";
@@ -715,9 +715,9 @@ export declare class InvalidSnsTopicArnException extends __BaseException {
715
715
  constructor(opts: __ExceptionOptionType<InvalidSnsTopicArnException, __BaseException>);
716
716
  }
717
717
  /**
718
- * @public
719
718
  * <p>The SSML you provided is invalid. Verify the SSML syntax, spelling
720
719
  * of tags and values, and then try again.</p>
720
+ * @public
721
721
  */
722
722
  export declare class InvalidSsmlException extends __BaseException {
723
723
  readonly name: "InvalidSsmlException";
@@ -728,9 +728,9 @@ export declare class InvalidSsmlException extends __BaseException {
728
728
  constructor(opts: __ExceptionOptionType<InvalidSsmlException, __BaseException>);
729
729
  }
730
730
  /**
731
- * @public
732
731
  * <p>The language specified is not currently supported by Amazon Polly in this
733
732
  * capacity.</p>
733
+ * @public
734
734
  */
735
735
  export declare class LanguageNotSupportedException extends __BaseException {
736
736
  readonly name: "LanguageNotSupportedException";
@@ -741,25 +741,25 @@ export declare class LanguageNotSupportedException extends __BaseException {
741
741
  constructor(opts: __ExceptionOptionType<LanguageNotSupportedException, __BaseException>);
742
742
  }
743
743
  /**
744
- * @public
745
744
  * <p>Describes the content of the lexicon.</p>
745
+ * @public
746
746
  */
747
747
  export interface LexiconDescription {
748
748
  /**
749
- * @public
750
749
  * <p>Name of the lexicon.</p>
750
+ * @public
751
751
  */
752
752
  Name?: string;
753
753
  /**
754
- * @public
755
754
  * <p>Provides lexicon metadata.</p>
755
+ * @public
756
756
  */
757
757
  Attributes?: LexiconAttributes;
758
758
  }
759
759
  /**
760
- * @public
761
760
  * <p>The maximum size of the specified lexicon would be exceeded by this
762
761
  * operation.</p>
762
+ * @public
763
763
  */
764
764
  export declare class LexiconSizeExceededException extends __BaseException {
765
765
  readonly name: "LexiconSizeExceededException";
@@ -774,10 +774,10 @@ export declare class LexiconSizeExceededException extends __BaseException {
774
774
  */
775
775
  export interface ListLexiconsInput {
776
776
  /**
777
- * @public
778
777
  * <p>An opaque pagination token returned from previous
779
778
  * <code>ListLexicons</code> operation. If present, indicates where to
780
779
  * continue the list of lexicons.</p>
780
+ * @public
781
781
  */
782
782
  NextToken?: string;
783
783
  }
@@ -786,15 +786,15 @@ export interface ListLexiconsInput {
786
786
  */
787
787
  export interface ListLexiconsOutput {
788
788
  /**
789
- * @public
790
789
  * <p>A list of lexicon names and attributes.</p>
790
+ * @public
791
791
  */
792
792
  Lexicons?: LexiconDescription[];
793
793
  /**
794
- * @public
795
794
  * <p>The pagination token to use in the next request to continue the
796
795
  * listing of lexicons. <code>NextToken</code> is returned only if the
797
796
  * response is truncated.</p>
797
+ * @public
798
798
  */
799
799
  NextToken?: string;
800
800
  }
@@ -803,21 +803,21 @@ export interface ListLexiconsOutput {
803
803
  */
804
804
  export interface ListSpeechSynthesisTasksInput {
805
805
  /**
806
- * @public
807
806
  * <p>Maximum number of speech synthesis tasks returned in a List
808
807
  * operation.</p>
808
+ * @public
809
809
  */
810
810
  MaxResults?: number;
811
811
  /**
812
- * @public
813
812
  * <p>The pagination token to use in the next request to continue the
814
813
  * listing of speech synthesis tasks. </p>
814
+ * @public
815
815
  */
816
816
  NextToken?: string;
817
817
  /**
818
- * @public
819
818
  * <p>Status of the speech synthesis tasks returned in a List
820
819
  * operation</p>
820
+ * @public
821
821
  */
822
822
  Status?: TaskStatus;
823
823
  }
@@ -826,25 +826,25 @@ export interface ListSpeechSynthesisTasksInput {
826
826
  */
827
827
  export interface ListSpeechSynthesisTasksOutput {
828
828
  /**
829
- * @public
830
829
  * <p>An opaque pagination token returned from the previous List operation
831
830
  * in this request. If present, this indicates where to continue the
832
831
  * listing.</p>
832
+ * @public
833
833
  */
834
834
  NextToken?: string;
835
835
  /**
836
- * @public
837
836
  * <p>List of SynthesisTask objects that provides information from the
838
837
  * specified task in the list request, including output format, creation
839
838
  * time, task status, and so on.</p>
839
+ * @public
840
840
  */
841
841
  SynthesisTasks?: SynthesisTask[];
842
842
  }
843
843
  /**
844
- * @public
845
844
  * <p>Speech marks are not supported for the <code>OutputFormat</code>
846
845
  * selected. Speech marks are only available for content in <code>json</code>
847
846
  * format.</p>
847
+ * @public
848
848
  */
849
849
  export declare class MarksNotSupportedForFormatException extends __BaseException {
850
850
  readonly name: "MarksNotSupportedForFormatException";
@@ -855,9 +855,9 @@ export declare class MarksNotSupportedForFormatException extends __BaseException
855
855
  constructor(opts: __ExceptionOptionType<MarksNotSupportedForFormatException, __BaseException>);
856
856
  }
857
857
  /**
858
- * @public
859
858
  * <p>The maximum size of the lexeme would be exceeded by this
860
859
  * operation.</p>
860
+ * @public
861
861
  */
862
862
  export declare class MaxLexemeLengthExceededException extends __BaseException {
863
863
  readonly name: "MaxLexemeLengthExceededException";
@@ -868,9 +868,9 @@ export declare class MaxLexemeLengthExceededException extends __BaseException {
868
868
  constructor(opts: __ExceptionOptionType<MaxLexemeLengthExceededException, __BaseException>);
869
869
  }
870
870
  /**
871
- * @public
872
871
  * <p>The maximum number of lexicons would be exceeded by this
873
872
  * operation.</p>
873
+ * @public
874
874
  */
875
875
  export declare class MaxLexiconsNumberExceededException extends __BaseException {
876
876
  readonly name: "MaxLexiconsNumberExceededException";
@@ -885,15 +885,15 @@ export declare class MaxLexiconsNumberExceededException extends __BaseException
885
885
  */
886
886
  export interface PutLexiconInput {
887
887
  /**
888
- * @public
889
888
  * <p>Name of the lexicon. The name must follow the regular express
890
889
  * format [0-9A-Za-z]\{1,20\}. That is, the name is a case-sensitive
891
890
  * alphanumeric string up to 20 characters long. </p>
891
+ * @public
892
892
  */
893
893
  Name: string | undefined;
894
894
  /**
895
- * @public
896
895
  * <p>Content of the PLS lexicon as string data.</p>
896
+ * @public
897
897
  */
898
898
  Content: string | undefined;
899
899
  }
@@ -903,9 +903,9 @@ export interface PutLexiconInput {
903
903
  export interface PutLexiconOutput {
904
904
  }
905
905
  /**
906
- * @public
907
906
  * <p>The alphabet specified by the lexicon is not a supported alphabet.
908
907
  * Valid values are <code>x-sampa</code> and <code>ipa</code>.</p>
908
+ * @public
909
909
  */
910
910
  export declare class UnsupportedPlsAlphabetException extends __BaseException {
911
911
  readonly name: "UnsupportedPlsAlphabetException";
@@ -916,9 +916,9 @@ export declare class UnsupportedPlsAlphabetException extends __BaseException {
916
916
  constructor(opts: __ExceptionOptionType<UnsupportedPlsAlphabetException, __BaseException>);
917
917
  }
918
918
  /**
919
- * @public
920
919
  * <p>The language specified in the lexicon is unsupported. For a list of
921
920
  * supported languages, see <a href="https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html">Lexicon Attributes</a>.</p>
921
+ * @public
922
922
  */
923
923
  export declare class UnsupportedPlsLanguageException extends __BaseException {
924
924
  readonly name: "UnsupportedPlsLanguageException";
@@ -929,9 +929,9 @@ export declare class UnsupportedPlsLanguageException extends __BaseException {
929
929
  constructor(opts: __ExceptionOptionType<UnsupportedPlsLanguageException, __BaseException>);
930
930
  }
931
931
  /**
932
- * @public
933
932
  * <p>SSML speech marks are not supported for plain text-type
934
933
  * input.</p>
934
+ * @public
935
935
  */
936
936
  export declare class SsmlMarksNotSupportedForTextTypeException extends __BaseException {
937
937
  readonly name: "SsmlMarksNotSupportedForTextTypeException";
@@ -946,15 +946,14 @@ export declare class SsmlMarksNotSupportedForTextTypeException extends __BaseExc
946
946
  */
947
947
  export interface StartSpeechSynthesisTaskInput {
948
948
  /**
949
- * @public
950
949
  * <p>Specifies the engine (<code>standard</code>, <code>neural</code> or
951
950
  * <code>long-form</code>) for Amazon Polly to use when processing input text for
952
951
  * speech synthesis. Using a voice that is not supported for the engine
953
952
  * selected will result in an error.</p>
953
+ * @public
954
954
  */
955
955
  Engine?: Engine;
956
956
  /**
957
- * @public
958
957
  * <p>Optional language code for the Speech Synthesis request. This is only
959
958
  * necessary if using a bilingual voice, such as Aditi, which can be used for
960
959
  * either Indian English (en-IN) or Hindi (hi-IN). </p>
@@ -963,34 +962,34 @@ export interface StartSpeechSynthesisTaskInput {
963
962
  * 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>
964
963
  * parameter. For example, if no language code is specified, Aditi will use
965
964
  * Indian English rather than Hindi.</p>
965
+ * @public
966
966
  */
967
967
  LanguageCode?: LanguageCode;
968
968
  /**
969
- * @public
970
969
  * <p>List of one or more pronunciation lexicon names you want the service
971
970
  * to apply during synthesis. Lexicons are applied only if the language of
972
971
  * the lexicon is the same as the language of the voice. </p>
972
+ * @public
973
973
  */
974
974
  LexiconNames?: string[];
975
975
  /**
976
- * @public
977
976
  * <p>The format in which the returned output will be encoded. For audio
978
977
  * stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will
979
978
  * be json. </p>
979
+ * @public
980
980
  */
981
981
  OutputFormat: OutputFormat | undefined;
982
982
  /**
983
- * @public
984
983
  * <p>Amazon S3 bucket name to which the output file will be saved.</p>
984
+ * @public
985
985
  */
986
986
  OutputS3BucketName: string | undefined;
987
987
  /**
988
- * @public
989
988
  * <p>The Amazon S3 key prefix for the output speech file.</p>
989
+ * @public
990
990
  */
991
991
  OutputS3KeyPrefix?: string;
992
992
  /**
993
- * @public
994
993
  * <p>The audio frequency specified in Hz.</p>
995
994
  * <p>The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
996
995
  * and "24000". The default value for standard voices is "22050". The default
@@ -998,34 +997,35 @@ export interface StartSpeechSynthesisTaskInput {
998
997
  * is "24000".</p>
999
998
  * <p>Valid values for pcm are "8000" and "16000" The default value is
1000
999
  * "16000". </p>
1000
+ * @public
1001
1001
  */
1002
1002
  SampleRate?: string;
1003
1003
  /**
1004
- * @public
1005
1004
  * <p>ARN for the SNS topic optionally used for providing status
1006
1005
  * notification for a speech synthesis task.</p>
1006
+ * @public
1007
1007
  */
1008
1008
  SnsTopicArn?: string;
1009
1009
  /**
1010
- * @public
1011
1010
  * <p>The type of speech marks returned for the input text.</p>
1011
+ * @public
1012
1012
  */
1013
1013
  SpeechMarkTypes?: SpeechMarkType[];
1014
1014
  /**
1015
- * @public
1016
1015
  * <p>The input text to synthesize. If you specify ssml as the TextType,
1017
1016
  * follow the SSML format for the input text. </p>
1017
+ * @public
1018
1018
  */
1019
1019
  Text: string | undefined;
1020
1020
  /**
1021
- * @public
1022
1021
  * <p>Specifies whether the input text is plain text or SSML. The default
1023
1022
  * value is plain text. </p>
1023
+ * @public
1024
1024
  */
1025
1025
  TextType?: TextType;
1026
1026
  /**
1027
- * @public
1028
1027
  * <p>Voice ID to use for the synthesis. </p>
1028
+ * @public
1029
1029
  */
1030
1030
  VoiceId: VoiceId | undefined;
1031
1031
  }
@@ -1034,14 +1034,13 @@ export interface StartSpeechSynthesisTaskInput {
1034
1034
  */
1035
1035
  export interface StartSpeechSynthesisTaskOutput {
1036
1036
  /**
1037
- * @public
1038
1037
  * <p>SynthesisTask object that provides information and attributes about a
1039
1038
  * newly submitted speech synthesis task.</p>
1039
+ * @public
1040
1040
  */
1041
1041
  SynthesisTask?: SynthesisTask;
1042
1042
  }
1043
1043
  /**
1044
- * @public
1045
1044
  * <p>The value of the "Text" parameter is longer than the accepted
1046
1045
  * limits. For the <code>SynthesizeSpeech</code> API, the limit for input
1047
1046
  * text is a maximum of 6000 characters total, of which no more than 3000 can
@@ -1049,6 +1048,7 @@ export interface StartSpeechSynthesisTaskOutput {
1049
1048
  * the maximum is 200,000 characters, of which no more than 100,000 can be
1050
1049
  * billed characters. SSML tags are not counted as billed
1051
1050
  * characters.</p>
1051
+ * @public
1052
1052
  */
1053
1053
  export declare class TextLengthExceededException extends __BaseException {
1054
1054
  readonly name: "TextLengthExceededException";
@@ -1063,7 +1063,6 @@ export declare class TextLengthExceededException extends __BaseException {
1063
1063
  */
1064
1064
  export interface SynthesizeSpeechInput {
1065
1065
  /**
1066
- * @public
1067
1066
  * <p>Specifies the engine (<code>standard</code>, <code>neural</code> or
1068
1067
  * <code>long-form</code>) for Amazon Polly to use when processing input text for
1069
1068
  * speech synthesis. For information on Amazon Polly voices and which voices are
@@ -1094,10 +1093,10 @@ export interface SynthesizeSpeechInput {
1094
1093
  * defaults to <code>standard</code>. If the engine is not specified, or is
1095
1094
  * set to <code>standard</code> and an NTTS-only voice is selected, this will
1096
1095
  * result in an error. </p>
1096
+ * @public
1097
1097
  */
1098
1098
  Engine?: Engine;
1099
1099
  /**
1100
- * @public
1101
1100
  * <p>Optional language code for the Synthesize Speech request. This is only
1102
1101
  * necessary if using a bilingual voice, such as Aditi, which can be used for
1103
1102
  * either Indian English (en-IN) or Hindi (hi-IN). </p>
@@ -1106,27 +1105,27 @@ export interface SynthesizeSpeechInput {
1106
1105
  * 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>
1107
1106
  * parameter. For example, if no language code is specified, Aditi will use
1108
1107
  * Indian English rather than Hindi.</p>
1108
+ * @public
1109
1109
  */
1110
1110
  LanguageCode?: LanguageCode;
1111
1111
  /**
1112
- * @public
1113
1112
  * <p>List of one or more pronunciation lexicon names you want the
1114
1113
  * service to apply during synthesis. Lexicons are applied only if the
1115
1114
  * language of the lexicon is the same as the language of the voice. For
1116
1115
  * information about storing lexicons, see <a href="https://docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html">PutLexicon</a>.</p>
1116
+ * @public
1117
1117
  */
1118
1118
  LexiconNames?: string[];
1119
1119
  /**
1120
- * @public
1121
1120
  * <p> The format in which the returned output will be encoded. For audio
1122
1121
  * stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will
1123
1122
  * be json. </p>
1124
1123
  * <p>When pcm is used, the content returned is audio/pcm in a signed
1125
1124
  * 16-bit, 1 channel (mono), little-endian format. </p>
1125
+ * @public
1126
1126
  */
1127
1127
  OutputFormat: OutputFormat | undefined;
1128
1128
  /**
1129
- * @public
1130
1129
  * <p>The audio frequency specified in Hz.</p>
1131
1130
  * <p>The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
1132
1131
  * and "24000". The default value for standard voices is "22050". The default
@@ -1134,31 +1133,32 @@ export interface SynthesizeSpeechInput {
1134
1133
  * is "24000".</p>
1135
1134
  * <p>Valid values for pcm are "8000" and "16000" The default value is
1136
1135
  * "16000". </p>
1136
+ * @public
1137
1137
  */
1138
1138
  SampleRate?: string;
1139
1139
  /**
1140
- * @public
1141
1140
  * <p>The type of speech marks returned for the input text.</p>
1141
+ * @public
1142
1142
  */
1143
1143
  SpeechMarkTypes?: SpeechMarkType[];
1144
1144
  /**
1145
- * @public
1146
1145
  * <p> Input text to synthesize. If you specify <code>ssml</code> as the
1147
1146
  * <code>TextType</code>, follow the SSML format for the input text.
1148
1147
  * </p>
1148
+ * @public
1149
1149
  */
1150
1150
  Text: string | undefined;
1151
1151
  /**
1152
- * @public
1153
1152
  * <p> Specifies whether the input text is plain text or SSML. The
1154
1153
  * default value is plain text. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/ssml.html">Using
1155
1154
  * SSML</a>.</p>
1155
+ * @public
1156
1156
  */
1157
1157
  TextType?: TextType;
1158
1158
  /**
1159
- * @public
1160
1159
  * <p> Voice ID to use for the synthesis. You can get a list of available
1161
1160
  * voice IDs by calling the <a href="https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html">DescribeVoices</a> operation. </p>
1161
+ * @public
1162
1162
  */
1163
1163
  VoiceId: VoiceId | undefined;
1164
1164
  }
@@ -1167,12 +1167,11 @@ export interface SynthesizeSpeechInput {
1167
1167
  */
1168
1168
  export interface SynthesizeSpeechOutput {
1169
1169
  /**
1170
- * @public
1171
1170
  * <p> Stream containing the synthesized speech. </p>
1171
+ * @public
1172
1172
  */
1173
1173
  AudioStream?: StreamingBlobTypes;
1174
1174
  /**
1175
- * @public
1176
1175
  * <p> Specifies the type audio stream. This should reflect the
1177
1176
  * <code>OutputFormat</code> parameter in your request. </p>
1178
1177
  * <ul>
@@ -1199,11 +1198,12 @@ export interface SynthesizeSpeechOutput {
1199
1198
  * </li>
1200
1199
  * </ul>
1201
1200
  * <p> </p>
1201
+ * @public
1202
1202
  */
1203
1203
  ContentType?: string;
1204
1204
  /**
1205
- * @public
1206
1205
  * <p>Number of characters synthesized.</p>
1206
+ * @public
1207
1207
  */
1208
1208
  RequestCharacters?: number;
1209
1209
  }