@aws-sdk/client-polly 3.296.0 → 3.298.0

package/dist-types/models/models_0.d.ts

@@ -2,6 +2,9 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { Readable } from "stream";
 import { PollyServiceException as __BaseException } from "./PollyServiceException";
+/**
+ * @public
+ */
 export interface DeleteLexiconInput {
     /**
      * <p>The name of the lexicon to delete. Must be an existing lexicon in
@@ -9,9 +12,13 @@ export interface DeleteLexiconInput {
      */
     Name: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteLexiconOutput {
 }
 /**
+ * @public
  * <p>Amazon Polly can't find the specified lexicon. This could be caused by a
  *       lexicon that is missing, its name is misspelled or specifying a lexicon
  *       that is in a different region.</p>
@@ -27,6 +34,7 @@ export declare class LexiconNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LexiconNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>An unknown condition has caused a service failure.</p>
  */
 export declare class ServiceFailureException extends __BaseException {
@@ -37,10 +45,16 @@ export declare class ServiceFailureException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServiceFailureException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum Engine {
     NEURAL = "neural",
     STANDARD = "standard"
 }
+/**
+ * @public
+ */
 export declare enum LanguageCode {
     ar_AE = "ar-AE",
     arb = "arb",
@@ -79,6 +93,9 @@ export declare enum LanguageCode {
     tr_TR = "tr-TR",
     yue_CN = "yue-CN"
 }
+/**
+ * @public
+ */
 export interface DescribeVoicesInput {
     /**
      * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
@@ -108,10 +125,16 @@ export interface DescribeVoicesInput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum Gender {
     Female = "Female",
     Male = "Male"
 }
+/**
+ * @public
+ */
 export declare enum VoiceId {
     Aditi = "Aditi",
     Adriano = "Adriano",
@@ -203,6 +226,7 @@ export declare enum VoiceId {
     Zhiyu = "Zhiyu"
 }
 /**
+ * @public
  * <p>Description of the voice.</p>
  */
 export interface Voice {
@@ -244,6 +268,9 @@ export interface Voice {
      */
     SupportedEngines?: (Engine | string)[];
 }
+/**
+ * @public
+ */
 export interface DescribeVoicesOutput {
     /**
      * <p>A list of voices with their properties.</p>
@@ -257,6 +284,7 @@ export interface DescribeVoicesOutput {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>The NextToken is invalid. Verify that it's spelled correctly, and
  *       then try again.</p>
  */
@@ -269,6 +297,7 @@ export declare class InvalidNextTokenException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
 }
 /**
+ * @public
  * <p>This engine is not compatible with the voice that you have designated.
  *       Choose a new voice that is compatible with the engine or change the engine
  *       and restart the operation.</p>
@@ -281,6 +310,9 @@ export declare class EngineNotSupportedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<EngineNotSupportedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface GetLexiconInput {
     /**
      * <p>Name of the lexicon.</p>
@@ -288,6 +320,7 @@ export interface GetLexiconInput {
     Name: string | undefined;
 }
 /**
+ * @public
  * <p>Provides lexicon name and lexicon content in string format. For
  *       more information, see <a href="https://www.w3.org/TR/pronunciation-lexicon/">Pronunciation Lexicon
  *         Specification (PLS) Version 1.0</a>.</p>
@@ -304,6 +337,7 @@ export interface Lexicon {
     Name?: string;
 }
 /**
+ * @public
  * <p>Contains metadata describing the lexicon such as the number of
  *       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>
  */
@@ -336,6 +370,9 @@ export interface LexiconAttributes {
      */
     Size?: number;
 }
+/**
+ * @public
+ */
 export interface GetLexiconOutput {
     /**
      * <p>Lexicon object that provides name and the string content of the
@@ -349,35 +386,51 @@ export interface GetLexiconOutput {
      */
     LexiconAttributes?: LexiconAttributes;
 }
+/**
+ * @public
+ */
 export interface GetSpeechSynthesisTaskInput {
     /**
      * <p>The Amazon Polly generated identifier for a speech synthesis task.</p>
      */
     TaskId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum OutputFormat {
     JSON = "json",
     MP3 = "mp3",
     OGG_VORBIS = "ogg_vorbis",
     PCM = "pcm"
 }
+/**
+ * @public
+ */
 export declare enum SpeechMarkType {
     SENTENCE = "sentence",
     SSML = "ssml",
     VISEME = "viseme",
     WORD = "word"
 }
+/**
+ * @public
+ */
 export declare enum TaskStatus {
     COMPLETED = "completed",
     FAILED = "failed",
     IN_PROGRESS = "inProgress",
     SCHEDULED = "scheduled"
 }
+/**
+ * @public
+ */
 export declare enum TextType {
     SSML = "ssml",
     TEXT = "text"
 }
 /**
+ * @public
  * <p>SynthesisTask object that provides information about a speech
  *       synthesis task.</p>
  */
@@ -465,6 +518,9 @@ export interface SynthesisTask {
      */
     LanguageCode?: LanguageCode | string;
 }
+/**
+ * @public
+ */
 export interface GetSpeechSynthesisTaskOutput {
     /**
      * <p>SynthesisTask object that provides information from the requested
@@ -474,6 +530,7 @@ export interface GetSpeechSynthesisTaskOutput {
     SynthesisTask?: SynthesisTask;
 }
 /**
+ * @public
  * <p>The provided Task ID is not valid. Please provide a valid Task ID and
  *       try again.</p>
  */
@@ -486,6 +543,7 @@ export declare class InvalidTaskIdException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidTaskIdException, __BaseException>);
 }
 /**
+ * @public
  * <p>The Speech Synthesis task with requested Task ID cannot be
  *       found.</p>
  */
@@ -498,6 +556,7 @@ export declare class SynthesisTaskNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<SynthesisTaskNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>Amazon Polly can't find the specified lexicon. Verify that the lexicon's
  *       name is spelled correctly, and then try again.</p>
  */
@@ -510,6 +569,7 @@ export declare class InvalidLexiconException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidLexiconException, __BaseException>);
 }
 /**
+ * @public
  * <p>The provided Amazon S3 bucket name is invalid. Please check your input
  *       with S3 bucket naming requirements and try again.</p>
  */
@@ -522,6 +582,7 @@ export declare class InvalidS3BucketException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidS3BucketException, __BaseException>);
 }
 /**
+ * @public
  * <p>The provided Amazon S3 key prefix is invalid. Please provide a valid
  *       S3 object key name.</p>
  */
@@ -534,6 +595,7 @@ export declare class InvalidS3KeyException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidS3KeyException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified sample rate is not valid.</p>
  */
 export declare class InvalidSampleRateException extends __BaseException {
@@ -545,6 +607,7 @@ export declare class InvalidSampleRateException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidSampleRateException, __BaseException>);
 }
 /**
+ * @public
  * <p>The provided SNS topic ARN is invalid. Please provide a valid SNS
  *       topic ARN and try again.</p>
  */
@@ -557,6 +620,7 @@ export declare class InvalidSnsTopicArnException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidSnsTopicArnException, __BaseException>);
 }
 /**
+ * @public
  * <p>The SSML you provided is invalid. Verify the SSML syntax, spelling
  *       of tags and values, and then try again.</p>
  */
@@ -569,6 +633,7 @@ export declare class InvalidSsmlException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidSsmlException, __BaseException>);
 }
 /**
+ * @public
  * <p>The language specified is not currently supported by Amazon Polly in this
  *       capacity.</p>
  */
@@ -581,6 +646,7 @@ export declare class LanguageNotSupportedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LanguageNotSupportedException, __BaseException>);
 }
 /**
+ * @public
  * <p>Describes the content of the lexicon.</p>
  */
 export interface LexiconDescription {
@@ -594,6 +660,7 @@ export interface LexiconDescription {
     Attributes?: LexiconAttributes;
 }
 /**
+ * @public
  * <p>The maximum size of the specified lexicon would be exceeded by this
  *       operation.</p>
  */
@@ -605,6 +672,9 @@ export declare class LexiconSizeExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<LexiconSizeExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ListLexiconsInput {
     /**
      * <p>An opaque pagination token returned from previous
@@ -613,6 +683,9 @@ export interface ListLexiconsInput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListLexiconsOutput {
     /**
      * <p>A list of lexicon names and attributes.</p>
@@ -625,6 +698,9 @@ export interface ListLexiconsOutput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListSpeechSynthesisTasksInput {
     /**
      * <p>Maximum number of speech synthesis tasks returned in a List
@@ -642,6 +718,9 @@ export interface ListSpeechSynthesisTasksInput {
      */
     Status?: TaskStatus | string;
 }
+/**
+ * @public
+ */
 export interface ListSpeechSynthesisTasksOutput {
     /**
      * <p>An opaque pagination token returned from the previous List operation
@@ -657,6 +736,7 @@ export interface ListSpeechSynthesisTasksOutput {
     SynthesisTasks?: SynthesisTask[];
 }
 /**
+ * @public
  * <p>Speech marks are not supported for the <code>OutputFormat</code>
  *       selected. Speech marks are only available for content in <code>json</code>
  *       format.</p>
@@ -670,6 +750,7 @@ export declare class MarksNotSupportedForFormatException extends __BaseException
     constructor(opts: __ExceptionOptionType<MarksNotSupportedForFormatException, __BaseException>);
 }
 /**
+ * @public
  * <p>The maximum size of the lexeme would be exceeded by this
  *       operation.</p>
  */
@@ -682,6 +763,7 @@ export declare class MaxLexemeLengthExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<MaxLexemeLengthExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The maximum number of lexicons would be exceeded by this
  *       operation.</p>
  */
@@ -693,10 +775,13 @@ export declare class MaxLexiconsNumberExceededException extends __BaseException
      */
     constructor(opts: __ExceptionOptionType<MaxLexiconsNumberExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface PutLexiconInput {
     /**
      * <p>Name of the lexicon. The name must follow the regular express
-     *       format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive
+     *       format [0-9A-Za-z]\{1,20\}. That is, the name is a case-sensitive
      *       alphanumeric string up to 20 characters long. </p>
      */
     Name: string | undefined;
@@ -705,9 +790,13 @@ export interface PutLexiconInput {
      */
     Content: string | undefined;
 }
+/**
+ * @public
+ */
 export interface PutLexiconOutput {
 }
 /**
+ * @public
  * <p>The alphabet specified by the lexicon is not a supported alphabet.
  *       Valid values are <code>x-sampa</code> and <code>ipa</code>.</p>
  */
@@ -720,6 +809,7 @@ export declare class UnsupportedPlsAlphabetException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnsupportedPlsAlphabetException, __BaseException>);
 }
 /**
+ * @public
  * <p>The language specified in the lexicon is unsupported. For a list of
  *       supported languages, see <a href="https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html">Lexicon Attributes</a>.</p>
  */
@@ -732,6 +822,7 @@ export declare class UnsupportedPlsLanguageException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnsupportedPlsLanguageException, __BaseException>);
 }
 /**
+ * @public
  * <p>SSML speech marks are not supported for plain text-type
  *       input.</p>
  */
@@ -743,6 +834,9 @@ export declare class SsmlMarksNotSupportedForTextTypeException extends __BaseExc
      */
     constructor(opts: __ExceptionOptionType<SsmlMarksNotSupportedForTextTypeException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface StartSpeechSynthesisTaskInput {
     /**
      * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
@@ -815,6 +909,9 @@ export interface StartSpeechSynthesisTaskInput {
      */
     VoiceId: VoiceId | string | undefined;
 }
+/**
+ * @public
+ */
 export interface StartSpeechSynthesisTaskOutput {
     /**
      * <p>SynthesisTask object that provides information and attributes about a
@@ -823,6 +920,7 @@ export interface StartSpeechSynthesisTaskOutput {
     SynthesisTask?: SynthesisTask;
 }
 /**
+ * @public
  * <p>The value of the "Text" parameter is longer than the accepted
  *       limits. For the <code>SynthesizeSpeech</code> API, the limit for input
  *       text is a maximum of 6000 characters total, of which no more than 3000 can
@@ -839,6 +937,9 @@ export declare class TextLengthExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TextLengthExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface SynthesizeSpeechInput {
     /**
      * <p>Specifies the engine (<code>standard</code> or <code>neural</code>)
@@ -922,6 +1023,9 @@ export interface SynthesizeSpeechInput {
      */
     VoiceId: VoiceId | string | undefined;
 }
+/**
+ * @public
+ */
 export interface SynthesizeSpeechOutput {
     /**
      * <p> Stream containing the synthesized speech. </p>
@@ -961,94 +1065,18 @@ export interface SynthesizeSpeechOutput {
      */
     RequestCharacters?: number;
 }
-/**
- * @internal
- */
-export declare const DeleteLexiconInputFilterSensitiveLog: (obj: DeleteLexiconInput) => any;
-/**
- * @internal
- */
-export declare const DeleteLexiconOutputFilterSensitiveLog: (obj: DeleteLexiconOutput) => any;
-/**
- * @internal
- */
-export declare const DescribeVoicesInputFilterSensitiveLog: (obj: DescribeVoicesInput) => any;
-/**
- * @internal
- */
-export declare const VoiceFilterSensitiveLog: (obj: Voice) => any;
-/**
- * @internal
- */
-export declare const DescribeVoicesOutputFilterSensitiveLog: (obj: DescribeVoicesOutput) => any;
-/**
- * @internal
- */
-export declare const GetLexiconInputFilterSensitiveLog: (obj: GetLexiconInput) => any;
 /**
  * @internal
  */
 export declare const LexiconFilterSensitiveLog: (obj: Lexicon) => any;
-/**
- * @internal
- */
-export declare const LexiconAttributesFilterSensitiveLog: (obj: LexiconAttributes) => any;
 /**
  * @internal
  */
 export declare const GetLexiconOutputFilterSensitiveLog: (obj: GetLexiconOutput) => any;
-/**
- * @internal
- */
-export declare const GetSpeechSynthesisTaskInputFilterSensitiveLog: (obj: GetSpeechSynthesisTaskInput) => any;
-/**
- * @internal
- */
-export declare const SynthesisTaskFilterSensitiveLog: (obj: SynthesisTask) => any;
-/**
- * @internal
- */
-export declare const GetSpeechSynthesisTaskOutputFilterSensitiveLog: (obj: GetSpeechSynthesisTaskOutput) => any;
-/**
- * @internal
- */
-export declare const LexiconDescriptionFilterSensitiveLog: (obj: LexiconDescription) => any;
-/**
- * @internal
- */
-export declare const ListLexiconsInputFilterSensitiveLog: (obj: ListLexiconsInput) => any;
-/**
- * @internal
- */
-export declare const ListLexiconsOutputFilterSensitiveLog: (obj: ListLexiconsOutput) => any;
-/**
- * @internal
- */
-export declare const ListSpeechSynthesisTasksInputFilterSensitiveLog: (obj: ListSpeechSynthesisTasksInput) => any;
-/**
- * @internal
- */
-export declare const ListSpeechSynthesisTasksOutputFilterSensitiveLog: (obj: ListSpeechSynthesisTasksOutput) => any;
 /**
  * @internal
  */
 export declare const PutLexiconInputFilterSensitiveLog: (obj: PutLexiconInput) => any;
-/**
- * @internal
- */
-export declare const PutLexiconOutputFilterSensitiveLog: (obj: PutLexiconOutput) => any;
-/**
- * @internal
- */
-export declare const StartSpeechSynthesisTaskInputFilterSensitiveLog: (obj: StartSpeechSynthesisTaskInput) => any;
-/**
- * @internal
- */
-export declare const StartSpeechSynthesisTaskOutputFilterSensitiveLog: (obj: StartSpeechSynthesisTaskOutput) => any;
-/**
- * @internal
- */
-export declare const SynthesizeSpeechInputFilterSensitiveLog: (obj: SynthesizeSpeechInput) => any;
 /**
  * @internal
  */

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { PollyClient } from "../PollyClient";
+/**
+ * @public
+ */
 export interface PollyPaginationConfiguration extends PaginationConfiguration {
     client: PollyClient;
 }

package/dist-types/pagination/ListSpeechSynthesisTasksPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListSpeechSynthesisTasksCommandInput, ListSpeechSynthesisTasksCommandOutput } from "../commands/ListSpeechSynthesisTasksCommand";
 import { PollyPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListSpeechSynthesisTasks(config: PollyPaginationConfiguration, input: ListSpeechSynthesisTasksCommandInput, ...additionalArguments: any): Paginator<ListSpeechSynthesisTasksCommandOutput>;

package/dist-types/ts3.4/models/models_0.d.ts

@@ -447,68 +447,13 @@ export interface SynthesizeSpeechOutput {
   ContentType?: string;
   RequestCharacters?: number;
 }
-export declare const DeleteLexiconInputFilterSensitiveLog: (
-  obj: DeleteLexiconInput
-) => any;
-export declare const DeleteLexiconOutputFilterSensitiveLog: (
-  obj: DeleteLexiconOutput
-) => any;
-export declare const DescribeVoicesInputFilterSensitiveLog: (
-  obj: DescribeVoicesInput
-) => any;
-export declare const VoiceFilterSensitiveLog: (obj: Voice) => any;
-export declare const DescribeVoicesOutputFilterSensitiveLog: (
-  obj: DescribeVoicesOutput
-) => any;
-export declare const GetLexiconInputFilterSensitiveLog: (
-  obj: GetLexiconInput
-) => any;
 export declare const LexiconFilterSensitiveLog: (obj: Lexicon) => any;
-export declare const LexiconAttributesFilterSensitiveLog: (
-  obj: LexiconAttributes
-) => any;
 export declare const GetLexiconOutputFilterSensitiveLog: (
   obj: GetLexiconOutput
 ) => any;
-export declare const GetSpeechSynthesisTaskInputFilterSensitiveLog: (
-  obj: GetSpeechSynthesisTaskInput
-) => any;
-export declare const SynthesisTaskFilterSensitiveLog: (
-  obj: SynthesisTask
-) => any;
-export declare const GetSpeechSynthesisTaskOutputFilterSensitiveLog: (
-  obj: GetSpeechSynthesisTaskOutput
-) => any;
-export declare const LexiconDescriptionFilterSensitiveLog: (
-  obj: LexiconDescription
-) => any;
-export declare const ListLexiconsInputFilterSensitiveLog: (
-  obj: ListLexiconsInput
-) => any;
-export declare const ListLexiconsOutputFilterSensitiveLog: (
-  obj: ListLexiconsOutput
-) => any;
-export declare const ListSpeechSynthesisTasksInputFilterSensitiveLog: (
-  obj: ListSpeechSynthesisTasksInput
-) => any;
-export declare const ListSpeechSynthesisTasksOutputFilterSensitiveLog: (
-  obj: ListSpeechSynthesisTasksOutput
-) => any;
 export declare const PutLexiconInputFilterSensitiveLog: (
   obj: PutLexiconInput
 ) => any;
-export declare const PutLexiconOutputFilterSensitiveLog: (
-  obj: PutLexiconOutput
-) => any;
-export declare const StartSpeechSynthesisTaskInputFilterSensitiveLog: (
-  obj: StartSpeechSynthesisTaskInput
-) => any;
-export declare const StartSpeechSynthesisTaskOutputFilterSensitiveLog: (
-  obj: StartSpeechSynthesisTaskOutput
-) => any;
-export declare const SynthesizeSpeechInputFilterSensitiveLog: (
-  obj: SynthesizeSpeechInput
-) => any;
 export declare const SynthesizeSpeechOutputFilterSensitiveLog: (
   obj: SynthesizeSpeechOutput
 ) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-polly",
   "description": "AWS SDK for JavaScript Polly Client for Node.js, Browser and React Native",
-  "version": "3.296.0",
+  "version": "3.298.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -11,6 +11,7 @@
     "build:types": "tsc -p tsconfig.types.json",
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
+    "extract:docs": "api-extractor run --local",
     "generate:client": "node ../../scripts/generate-clients/single-service --solo polly"
   },
   "main": "./dist-cjs/index.js",
@@ -20,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.298.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.298.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",