@aws-sdk/client-polly 3.776.0 → 3.782.0

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

@@ -65,18 +65,21 @@ 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.
  * const input = {
- *   "Name": "example"
+ *   Name: "example"
  * };
  * const command = new DeleteLexiconCommand(input);
- * await client.send(command);
- * // example id: to-delete-a-lexicon-1481922498332
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteLexiconCommand extends DeleteLexiconCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -94,45 +94,45 @@ 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.
  * const input = {
- *   "LanguageCode": "en-GB"
+ *   LanguageCode: "en-GB"
  * };
  * const command = new DescribeVoicesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Voices": [
+ *   Voices: [
  *     {
- *       "Gender": "Female",
- *       "Id": "Emma",
- *       "LanguageCode": "en-GB",
- *       "LanguageName": "British English",
- *       "Name": "Emma"
+ *       Gender: "Female",
+ *       Id: "Emma",
+ *       LanguageCode: "en-GB",
+ *       LanguageName: "British English",
+ *       Name: "Emma"
  *     },
  *     {
- *       "Gender": "Male",
- *       "Id": "Brian",
- *       "LanguageCode": "en-GB",
- *       "LanguageName": "British English",
- *       "Name": "Brian"
+ *       Gender: "Male",
+ *       Id: "Brian",
+ *       LanguageCode: "en-GB",
+ *       LanguageName: "British English",
+ *       Name: "Brian"
  *     },
  *     {
- *       "Gender": "Female",
- *       "Id": "Amy",
- *       "LanguageCode": "en-GB",
- *       "LanguageName": "British English",
- *       "Name": "Amy"
+ *       Gender: "Female",
+ *       Id: "Amy",
+ *       LanguageCode: "en-GB",
+ *       LanguageName: "British English",
+ *       Name: "Amy"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-available-voices-1482180557753
  * ```
  *
+ * @public
  */
 export declare class DescribeVoicesCommand extends DescribeVoicesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -76,34 +76,8 @@ 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.
- * const input = {
- *   "Name": ""
- * };
- * const command = new GetLexiconCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "Lexicon": {
- *     "Content": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<lexicon version=\"1.0\" \r\n      xmlns=\"http://www.w3.org/2005/01/pronunciation-lexicon\"\r\n      xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" \r\n      xsi:schemaLocation=\"http://www.w3.org/2005/01/pronunciation-lexicon \r\n        http://www.w3.org/TR/2007/CR-pronunciation-lexicon-20071212/pls.xsd\"\r\n      alphabet=\"ipa\" \r\n      xml:lang=\"en-US\">\r\n  <lexeme>\r\n    <grapheme>W3C</grapheme>\r\n    <alias>World Wide Web Consortium</alias>\r\n  </lexeme>\r\n</lexicon>",
- *     "Name": "example"
- *   },
- *   "LexiconAttributes": {
- *     "Alphabet": "ipa",
- *     "LanguageCode": "en-US",
- *     "LastModified": 1478542980.117,
- *     "LexemesCount": 1,
- *     "LexiconArn": "arn:aws:polly:us-east-1:123456789012:lexicon/example",
- *     "Size": 503
- *   }
- * }
- * *\/
- * // example id: to-retrieve-a-lexicon-1481912870836
- * ```
  *
+ * @public
  */
 export declare class GetLexiconCommand extends GetLexiconCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -88,6 +88,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

@@ -74,33 +74,33 @@ 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.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new ListLexiconsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Lexicons": [
+ *   Lexicons: [
  *     {
- *       "Attributes": {
- *         "Alphabet": "ipa",
- *         "LanguageCode": "en-US",
- *         "LastModified": 1478542980.117,
- *         "LexemesCount": 1,
- *         "LexiconArn": "arn:aws:polly:us-east-1:123456789012:lexicon/example",
- *         "Size": 503
+ *       Attributes: {
+ *         Alphabet: "ipa",
+ *         LanguageCode: "en-US",
+ *         LastModified: 1.478542980117E9,
+ *         LexemesCount: 1,
+ *         LexiconArn: "arn:aws:polly:us-east-1:123456789012:lexicon/example",
+ *         Size: 503
  *       },
- *       "Name": "example"
+ *       Name: "example"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-list-all-lexicons-in-a-region-1481842106487
  * ```
  *
+ * @public
  */
 export declare class ListLexiconsCommand extends ListLexiconsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -88,6 +88,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

@@ -85,19 +85,22 @@ 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.
  * const input = {
- *   "Content": "<Lexicon Content>",
- *   "Name": "W3C"
+ *   Content: "<Lexicon Content>",
+ *   Name: "W3C"
  * };
  * const command = new PutLexiconCommand(input);
- * await client.send(command);
- * // example id: to-save-a-lexicon-1482272584088
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutLexiconCommand extends PutLexiconCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -154,6 +154,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

@@ -56,6 +56,11 @@ declare const SynthesizeSpeechCommand_base: {
  * };
  * const command = new SynthesizeSpeechCommand(input);
  * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.AudioStream.transformToByteArray();
+ * // const str = await response.AudioStream.transformToString();
+ * // response.AudioStream.destroy(); // only applicable to Node.js Readable streams.
+ *
  * // { // SynthesizeSpeechOutput
  * //   AudioStream: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
  * //   ContentType: "STRING_VALUE",
@@ -117,32 +122,37 @@ 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.
  * const input = {
- *   "LexiconNames": [
+ *   LexiconNames: [
  *     "example"
  *   ],
- *   "OutputFormat": "mp3",
- *   "SampleRate": "8000",
- *   "Text": "All Gaul is divided into three parts",
- *   "TextType": "text",
- *   "VoiceId": "Joanna"
+ *   OutputFormat: "mp3",
+ *   SampleRate: "8000",
+ *   Text: "All Gaul is divided into three parts",
+ *   TextType: "text",
+ *   VoiceId: "Joanna"
  * };
  * const command = new SynthesizeSpeechCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.AudioStream.transformToByteArray();
+ * // const str = await response.AudioStream.transformToString();
+ * // response.AudioStream.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
  * {
- *   "AudioStream": "TEXT",
- *   "ContentType": "audio/mpeg",
- *   "RequestCharacters": 37
+ *   AudioStream: "TEXT",
+ *   ContentType: "audio/mpeg",
+ *   RequestCharacters: 37
  * }
  * *\/
- * // example id: to-synthesize-speech-1482186064046
  * ```
  *
+ * @public
  */
 export declare class SynthesizeSpeechCommand extends SynthesizeSpeechCommand_base {
     /** @internal type navigation helper, not in runtime. */

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.776.0",
+  "version": "3.782.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-polly",
@@ -21,16 +21,16 @@
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
     "@aws-sdk/core": "3.775.0",
-    "@aws-sdk/credential-provider-node": "3.775.0",
+    "@aws-sdk/credential-provider-node": "3.782.0",
     "@aws-sdk/middleware-host-header": "3.775.0",
     "@aws-sdk/middleware-logger": "3.775.0",
     "@aws-sdk/middleware-recursion-detection": "3.775.0",
-    "@aws-sdk/middleware-user-agent": "3.775.0",
+    "@aws-sdk/middleware-user-agent": "3.782.0",
     "@aws-sdk/region-config-resolver": "3.775.0",
     "@aws-sdk/types": "3.775.0",
-    "@aws-sdk/util-endpoints": "3.775.0",
+    "@aws-sdk/util-endpoints": "3.782.0",
     "@aws-sdk/util-user-agent-browser": "3.775.0",
-    "@aws-sdk/util-user-agent-node": "3.775.0",
+    "@aws-sdk/util-user-agent-node": "3.782.0",
     "@smithy/config-resolver": "^4.1.0",
     "@smithy/core": "^3.2.0",
     "@smithy/fetch-http-handler": "^5.0.2",