@aws-sdk/client-polly 3.529.1 → 3.535.0

package/dist-types/Polly.d.ts

@@ -19,6 +19,7 @@ export interface Polly {
     /**
      * @see {@link DescribeVoicesCommand}
      */
+    describeVoices(): Promise<DescribeVoicesCommandOutput>;
     describeVoices(args: DescribeVoicesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeVoicesCommandOutput>;
     describeVoices(args: DescribeVoicesCommandInput, cb: (err: any, data?: DescribeVoicesCommandOutput) => void): void;
     describeVoices(args: DescribeVoicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVoicesCommandOutput) => void): void;
@@ -37,12 +38,14 @@ export interface Polly {
     /**
      * @see {@link ListLexiconsCommand}
      */
+    listLexicons(): Promise<ListLexiconsCommandOutput>;
     listLexicons(args: ListLexiconsCommandInput, options?: __HttpHandlerOptions): Promise<ListLexiconsCommandOutput>;
     listLexicons(args: ListLexiconsCommandInput, cb: (err: any, data?: ListLexiconsCommandOutput) => void): void;
     listLexicons(args: ListLexiconsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLexiconsCommandOutput) => void): void;
     /**
      * @see {@link ListSpeechSynthesisTasksCommand}
      */
+    listSpeechSynthesisTasks(): Promise<ListSpeechSynthesisTasksCommandOutput>;
     listSpeechSynthesisTasks(args: ListSpeechSynthesisTasksCommandInput, options?: __HttpHandlerOptions): Promise<ListSpeechSynthesisTasksCommandOutput>;
     listSpeechSynthesisTasks(args: ListSpeechSynthesisTasksCommandInput, cb: (err: any, data?: ListSpeechSynthesisTasksCommandOutput) => void): void;
     listSpeechSynthesisTasks(args: ListSpeechSynthesisTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSpeechSynthesisTasksCommandOutput) => void): void;
@@ -66,13 +69,13 @@ export interface Polly {
     synthesizeSpeech(args: SynthesizeSpeechCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SynthesizeSpeechCommandOutput) => void): void;
 }
 /**
- * @public
  * <p>Amazon Polly is a web service that makes it easy to synthesize speech from
  *       text.</p>
  *          <p>The Amazon Polly service provides API operations for synthesizing
  *       high-quality speech from plain text and Speech Synthesis Markup Language
  *       (SSML), along with managing pronunciations lexicons that enable you to get
  *       the best results for your application domain.</p>
+ * @public
  */
 export declare class Polly extends PollyClient implements Polly {
 }

package/dist-types/PollyClient.d.ts

@@ -165,13 +165,13 @@ export type PollyClientResolvedConfigType = __SmithyResolvedConfiguration<__Http
 export interface PollyClientResolvedConfig extends PollyClientResolvedConfigType {
 }
 /**
- * @public
  * <p>Amazon Polly is a web service that makes it easy to synthesize speech from
  *       text.</p>
  *          <p>The Amazon Polly service provides API operations for synthesizing
  *       high-quality speech from plain text and Speech Synthesis Markup Language
  *       (SSML), along with managing pronunciations lexicons that enable you to get
  *       the best results for your application domain.</p>
+ * @public
  */
 export declare class PollyClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PollyClientResolvedConfig> {
     /**

package/dist-types/commands/DeleteLexiconCommand.d.ts

@@ -22,10 +22,10 @@ export interface DeleteLexiconCommandOutput extends DeleteLexiconOutput, __Metad
 }
 declare const DeleteLexiconCommand_base: {
     new (input: DeleteLexiconCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteLexiconCommandInput, DeleteLexiconCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DeleteLexiconCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteLexiconCommandInput, DeleteLexiconCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for
  *       speech synthesis, nor is it possible to retrieve it using either the
  *         <code>GetLexicon</code> or <code>ListLexicon</code> APIs.</p>
@@ -64,6 +64,7 @@ declare const DeleteLexiconCommand_base: {
  * @throws {@link PollyServiceException}
  * <p>Base exception class for all service exceptions from Polly service.</p>
  *
+ * @public
  * @example To delete a lexicon
  * ```javascript
  * // Deletes a specified pronunciation lexicon stored in an AWS Region.

package/dist-types/commands/DescribeVoicesCommand.d.ts

@@ -22,10 +22,10 @@ export interface DescribeVoicesCommandOutput extends DescribeVoicesOutput, __Met
 }
 declare const DescribeVoicesCommand_base: {
     new (input: DescribeVoicesCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeVoicesCommandInput, DescribeVoicesCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [DescribeVoicesCommandInput]): import("@smithy/smithy-client").CommandImpl<DescribeVoicesCommandInput, DescribeVoicesCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Returns the list of voices that are available for use when
  *       requesting speech synthesis. Each voice speaks a specified language, is
  *       either male or female, and is identified by an ID, which is the ASCII
@@ -93,6 +93,7 @@ declare const DescribeVoicesCommand_base: {
  * @throws {@link PollyServiceException}
  * <p>Base exception class for all service exceptions from Polly service.</p>
  *
+ * @public
  * @example To describe available voices
  * ```javascript
  * // Returns the list of voices that are available for use when requesting speech synthesis. Displayed languages are those within the specified language code. If no language code is specified, voices for all available languages are displayed.

package/dist-types/commands/GetLexiconCommand.d.ts

@@ -22,10 +22,10 @@ export interface GetLexiconCommandOutput extends GetLexiconOutput, __MetadataBea
 }
 declare const GetLexiconCommand_base: {
     new (input: GetLexiconCommandInput): import("@smithy/smithy-client").CommandImpl<GetLexiconCommandInput, GetLexiconCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetLexiconCommandInput): import("@smithy/smithy-client").CommandImpl<GetLexiconCommandInput, GetLexiconCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Returns the content of the specified pronunciation lexicon stored
  *       in an Amazon Web Services Region. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>.</p>
  * @example
@@ -75,6 +75,7 @@ declare const GetLexiconCommand_base: {
  * @throws {@link PollyServiceException}
  * <p>Base exception class for all service exceptions from Polly service.</p>
  *
+ * @public
  * @example To retrieve a lexicon
  * ```javascript
  * // Returns the content of the specified pronunciation lexicon stored in an AWS Region.

package/dist-types/commands/GetSpeechSynthesisTaskCommand.d.ts

@@ -22,10 +22,10 @@ export interface GetSpeechSynthesisTaskCommandOutput extends GetSpeechSynthesisT
 }
 declare const GetSpeechSynthesisTaskCommand_base: {
     new (input: GetSpeechSynthesisTaskCommandInput): import("@smithy/smithy-client").CommandImpl<GetSpeechSynthesisTaskCommandInput, GetSpeechSynthesisTaskCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetSpeechSynthesisTaskCommandInput): import("@smithy/smithy-client").CommandImpl<GetSpeechSynthesisTaskCommandInput, GetSpeechSynthesisTaskCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Retrieves a specific SpeechSynthesisTask object based on its TaskID.
  *       This object contains information about the given speech synthesis task,
  *       including the status of the task, and a link to the S3 bucket containing
@@ -87,6 +87,7 @@ declare const GetSpeechSynthesisTaskCommand_base: {
  * @throws {@link PollyServiceException}
  * <p>Base exception class for all service exceptions from Polly service.</p>
  *
+ * @public
  */
 export declare class GetSpeechSynthesisTaskCommand extends GetSpeechSynthesisTaskCommand_base {
 }

package/dist-types/commands/ListLexiconsCommand.d.ts

@@ -22,10 +22,10 @@ export interface ListLexiconsCommandOutput extends ListLexiconsOutput, __Metadat
 }
 declare const ListLexiconsCommand_base: {
     new (input: ListLexiconsCommandInput): import("@smithy/smithy-client").CommandImpl<ListLexiconsCommandInput, ListLexiconsCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListLexiconsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListLexiconsCommandInput, ListLexiconsCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see <a href="https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -73,6 +73,7 @@ declare const ListLexiconsCommand_base: {
  * @throws {@link PollyServiceException}
  * <p>Base exception class for all service exceptions from Polly service.</p>
  *
+ * @public
  * @example To list all lexicons in a region
  * ```javascript
  * // Returns a list of pronunciation lexicons stored in an AWS Region.

package/dist-types/commands/ListSpeechSynthesisTasksCommand.d.ts

@@ -22,10 +22,10 @@ export interface ListSpeechSynthesisTasksCommandOutput extends ListSpeechSynthes
 }
 declare const ListSpeechSynthesisTasksCommand_base: {
     new (input: ListSpeechSynthesisTasksCommandInput): import("@smithy/smithy-client").CommandImpl<ListSpeechSynthesisTasksCommandInput, ListSpeechSynthesisTasksCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListSpeechSynthesisTasksCommandInput]): import("@smithy/smithy-client").CommandImpl<ListSpeechSynthesisTasksCommandInput, ListSpeechSynthesisTasksCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Returns a list of SpeechSynthesisTask objects ordered by their
  *       creation date. This operation can filter the tasks by their status, for
  *       example, allowing users to list only tasks that are completed.</p>
@@ -87,6 +87,7 @@ declare const ListSpeechSynthesisTasksCommand_base: {
  * @throws {@link PollyServiceException}
  * <p>Base exception class for all service exceptions from Polly service.</p>
  *
+ * @public
  */
 export declare class ListSpeechSynthesisTasksCommand extends ListSpeechSynthesisTasksCommand_base {
 }

package/dist-types/commands/PutLexiconCommand.d.ts

@@ -22,10 +22,10 @@ export interface PutLexiconCommandOutput extends PutLexiconOutput, __MetadataBea
 }
 declare const PutLexiconCommand_base: {
     new (input: PutLexiconCommandInput): import("@smithy/smithy-client").CommandImpl<PutLexiconCommandInput, PutLexiconCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PutLexiconCommandInput): import("@smithy/smithy-client").CommandImpl<PutLexiconCommandInput, PutLexiconCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Stores a pronunciation lexicon in an Amazon Web Services Region. If
  *       a lexicon with the same name already exists in the region, it is
  *       overwritten by the new lexicon. Lexicon operations have eventual
@@ -84,6 +84,7 @@ declare const PutLexiconCommand_base: {
  * @throws {@link PollyServiceException}
  * <p>Base exception class for all service exceptions from Polly service.</p>
  *
+ * @public
  * @example To save a lexicon
  * ```javascript
  * // Stores a pronunciation lexicon in an AWS Region.

package/dist-types/commands/StartSpeechSynthesisTaskCommand.d.ts

@@ -22,10 +22,10 @@ export interface StartSpeechSynthesisTaskCommandOutput extends StartSpeechSynthe
 }
 declare const StartSpeechSynthesisTaskCommand_base: {
     new (input: StartSpeechSynthesisTaskCommandInput): import("@smithy/smithy-client").CommandImpl<StartSpeechSynthesisTaskCommandInput, StartSpeechSynthesisTaskCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: StartSpeechSynthesisTaskCommandInput): import("@smithy/smithy-client").CommandImpl<StartSpeechSynthesisTaskCommandInput, StartSpeechSynthesisTaskCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Allows the creation of an asynchronous synthesis task, by starting a
  *       new <code>SpeechSynthesisTask</code>. This operation requires all the
  *       standard information needed for speech synthesis, plus the name of an
@@ -153,6 +153,7 @@ declare const StartSpeechSynthesisTaskCommand_base: {
  * @throws {@link PollyServiceException}
  * <p>Base exception class for all service exceptions from Polly service.</p>
  *
+ * @public
  */
 export declare class StartSpeechSynthesisTaskCommand extends StartSpeechSynthesisTaskCommand_base {
 }

package/dist-types/commands/SynthesizeSpeechCommand.d.ts

@@ -23,10 +23,10 @@ export interface SynthesizeSpeechCommandOutput extends Omit<SynthesizeSpeechOutp
 }
 declare const SynthesizeSpeechCommand_base: {
     new (input: SynthesizeSpeechCommandInput): import("@smithy/smithy-client").CommandImpl<SynthesizeSpeechCommandInput, SynthesizeSpeechCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: SynthesizeSpeechCommandInput): import("@smithy/smithy-client").CommandImpl<SynthesizeSpeechCommandInput, SynthesizeSpeechCommandOutput, PollyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
  *       SSML input must be valid, well-formed SSML. Some alphabets might not be
  *       available with all the voices (for example, Cyrillic might not be read at
@@ -56,7 +56,7 @@ declare const SynthesizeSpeechCommand_base: {
  * const command = new SynthesizeSpeechCommand(input);
  * const response = await client.send(command);
  * // { // SynthesizeSpeechOutput
- * //   AudioStream: "STREAMING_BLOB_VALUE",
+ * //   AudioStream: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
  * //   ContentType: "STRING_VALUE",
  * //   RequestCharacters: Number("int"),
  * // };
@@ -116,6 +116,7 @@ declare const SynthesizeSpeechCommand_base: {
  * @throws {@link PollyServiceException}
  * <p>Base exception class for all service exceptions from Polly service.</p>
  *
+ * @public
  * @example To synthesize speech
  * ```javascript
  * // Synthesizes plain text or SSML into a file of human-like speech.