@aws-sdk/client-polly 3.289.0 → 3.292.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 (10) hide show
  1. package/dist-types/commands/DeleteLexiconCommand.d.ts +11 -0
  2. package/dist-types/commands/DescribeVoicesCommand.d.ts +8 -0
  3. package/dist-types/commands/GetLexiconCommand.d.ts +11 -0
  4. package/dist-types/commands/GetSpeechSynthesisTaskCommand.d.ts +12 -0
  5. package/dist-types/commands/ListLexiconsCommand.d.ts +8 -0
  6. package/dist-types/commands/ListSpeechSynthesisTasksCommand.d.ts +8 -0
  7. package/dist-types/commands/PutLexiconCommand.d.ts +28 -0
  8. package/dist-types/commands/StartSpeechSynthesisTaskCommand.d.ts +57 -0
  9. package/dist-types/commands/SynthesizeSpeechCommand.d.ts +45 -0
  10. package/package.json +37 -42
package/dist-types/commands/DeleteLexiconCommand.d.ts CHANGED
@@ -32,6 +32,17 @@ export interface DeleteLexiconCommandOutput extends DeleteLexiconOutput, __Metad
32
32
  * @see {@link DeleteLexiconCommandOutput} for command's `response` shape.
33
33
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
34
34
  *
35
+ * @throws {@link LexiconNotFoundException} (client fault)
36
+ * <p>Amazon Polly can't find the specified lexicon. This could be caused by a
37
+ * lexicon that is missing, its name is misspelled or specifying a lexicon
38
+ * that is in a different region.</p>
39
+ * <p>Verify that the lexicon exists, is in the region (see <a>ListLexicons</a>) and that you spelled its name is spelled
40
+ * correctly. Then try again.</p>
41
+ *
42
+ * @throws {@link ServiceFailureException} (server fault)
43
+ * <p>An unknown condition has caused a service failure.</p>
44
+ *
45
+ *
35
46
  * @example To delete a lexicon
36
47
  * ```javascript
37
48
  * // Deletes a specified pronunciation lexicon stored in an AWS Region.
package/dist-types/commands/DescribeVoicesCommand.d.ts CHANGED
@@ -44,6 +44,14 @@ export interface DescribeVoicesCommandOutput extends DescribeVoicesOutput, __Met
44
44
  * @see {@link DescribeVoicesCommandOutput} for command's `response` shape.
45
45
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
46
46
  *
47
+ * @throws {@link InvalidNextTokenException} (client fault)
48
+ * <p>The NextToken is invalid. Verify that it's spelled correctly, and
49
+ * then try again.</p>
50
+ *
51
+ * @throws {@link ServiceFailureException} (server fault)
52
+ * <p>An unknown condition has caused a service failure.</p>
53
+ *
54
+ *
47
55
  * @example To describe available voices
48
56
  * ```javascript
49
57
  * // 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 CHANGED
@@ -30,6 +30,17 @@ export interface GetLexiconCommandOutput extends GetLexiconOutput, __MetadataBea
30
30
  * @see {@link GetLexiconCommandOutput} for command's `response` shape.
31
31
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
32
32
  *
33
+ * @throws {@link LexiconNotFoundException} (client fault)
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
+ * @throws {@link ServiceFailureException} (server fault)
41
+ * <p>An unknown condition has caused a service failure.</p>
42
+ *
43
+ *
33
44
  * @example To retrieve a lexicon
34
45
  * ```javascript
35
46
  * // Returns the content of the specified pronunciation lexicon stored in an AWS Region.
package/dist-types/commands/GetSpeechSynthesisTaskCommand.d.ts CHANGED
@@ -32,6 +32,18 @@ export interface GetSpeechSynthesisTaskCommandOutput extends GetSpeechSynthesisT
32
32
  * @see {@link GetSpeechSynthesisTaskCommandOutput} for command's `response` shape.
33
33
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
34
34
  *
35
+ * @throws {@link InvalidTaskIdException} (client fault)
36
+ * <p>The provided Task ID is not valid. Please provide a valid Task ID and
37
+ * try again.</p>
38
+ *
39
+ * @throws {@link ServiceFailureException} (server fault)
40
+ * <p>An unknown condition has caused a service failure.</p>
41
+ *
42
+ * @throws {@link SynthesisTaskNotFoundException} (client fault)
43
+ * <p>The Speech Synthesis task with requested Task ID cannot be
44
+ * found.</p>
45
+ *
46
+ *
35
47
  */
36
48
  export declare class GetSpeechSynthesisTaskCommand extends $Command<GetSpeechSynthesisTaskCommandInput, GetSpeechSynthesisTaskCommandOutput, PollyClientResolvedConfig> {
37
49
  readonly input: GetSpeechSynthesisTaskCommandInput;
package/dist-types/commands/ListLexiconsCommand.d.ts CHANGED
@@ -29,6 +29,14 @@ export interface ListLexiconsCommandOutput extends ListLexiconsOutput, __Metadat
29
29
  * @see {@link ListLexiconsCommandOutput} for command's `response` shape.
30
30
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidNextTokenException} (client fault)
33
+ * <p>The NextToken is invalid. Verify that it's spelled correctly, and
34
+ * then try again.</p>
35
+ *
36
+ * @throws {@link ServiceFailureException} (server fault)
37
+ * <p>An unknown condition has caused a service failure.</p>
38
+ *
39
+ *
32
40
  * @example To list all lexicons in a region
33
41
  * ```javascript
34
42
  * // Returns a list of pronunciation lexicons stored in an AWS Region.
package/dist-types/commands/ListSpeechSynthesisTasksCommand.d.ts CHANGED
@@ -31,6 +31,14 @@ export interface ListSpeechSynthesisTasksCommandOutput extends ListSpeechSynthes
31
31
  * @see {@link ListSpeechSynthesisTasksCommandOutput} for command's `response` shape.
32
32
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
33
33
  *
34
+ * @throws {@link InvalidNextTokenException} (client fault)
35
+ * <p>The NextToken is invalid. Verify that it's spelled correctly, and
36
+ * then try again.</p>
37
+ *
38
+ * @throws {@link ServiceFailureException} (server fault)
39
+ * <p>An unknown condition has caused a service failure.</p>
40
+ *
41
+ *
34
42
  */
35
43
  export declare class ListSpeechSynthesisTasksCommand extends $Command<ListSpeechSynthesisTasksCommandInput, ListSpeechSynthesisTasksCommandOutput, PollyClientResolvedConfig> {
36
44
  readonly input: ListSpeechSynthesisTasksCommandInput;
package/dist-types/commands/PutLexiconCommand.d.ts CHANGED
@@ -34,6 +34,34 @@ export interface PutLexiconCommandOutput extends PutLexiconOutput, __MetadataBea
34
34
  * @see {@link PutLexiconCommandOutput} for command's `response` shape.
35
35
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
36
36
  *
37
+ * @throws {@link InvalidLexiconException} (client fault)
38
+ * <p>Amazon Polly can't find the specified lexicon. Verify that the lexicon's
39
+ * name is spelled correctly, and then try again.</p>
40
+ *
41
+ * @throws {@link LexiconSizeExceededException} (client fault)
42
+ * <p>The maximum size of the specified lexicon would be exceeded by this
43
+ * operation.</p>
44
+ *
45
+ * @throws {@link MaxLexemeLengthExceededException} (client fault)
46
+ * <p>The maximum size of the lexeme would be exceeded by this
47
+ * operation.</p>
48
+ *
49
+ * @throws {@link MaxLexiconsNumberExceededException} (client fault)
50
+ * <p>The maximum number of lexicons would be exceeded by this
51
+ * operation.</p>
52
+ *
53
+ * @throws {@link ServiceFailureException} (server fault)
54
+ * <p>An unknown condition has caused a service failure.</p>
55
+ *
56
+ * @throws {@link UnsupportedPlsAlphabetException} (client fault)
57
+ * <p>The alphabet specified by the lexicon is not a supported alphabet.
58
+ * Valid values are <code>x-sampa</code> and <code>ipa</code>.</p>
59
+ *
60
+ * @throws {@link UnsupportedPlsLanguageException} (client fault)
61
+ * <p>The language specified in the lexicon is unsupported. For a list of
62
+ * supported languages, see <a href="https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html">Lexicon Attributes</a>.</p>
63
+ *
64
+ *
37
65
  * @example To save a lexicon
38
66
  * ```javascript
39
67
  * // Stores a pronunciation lexicon in an AWS Region.
package/dist-types/commands/StartSpeechSynthesisTaskCommand.d.ts CHANGED
@@ -38,6 +38,63 @@ export interface StartSpeechSynthesisTaskCommandOutput extends StartSpeechSynthe
38
38
  * @see {@link StartSpeechSynthesisTaskCommandOutput} for command's `response` shape.
39
39
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
40
40
  *
41
+ * @throws {@link EngineNotSupportedException} (client fault)
42
+ * <p>This engine is not compatible with the voice that you have designated.
43
+ * Choose a new voice that is compatible with the engine or change the engine
44
+ * and restart the operation.</p>
45
+ *
46
+ * @throws {@link InvalidS3BucketException} (client fault)
47
+ * <p>The provided Amazon S3 bucket name is invalid. Please check your input
48
+ * with S3 bucket naming requirements and try again.</p>
49
+ *
50
+ * @throws {@link InvalidS3KeyException} (client fault)
51
+ * <p>The provided Amazon S3 key prefix is invalid. Please provide a valid
52
+ * S3 object key name.</p>
53
+ *
54
+ * @throws {@link InvalidSampleRateException} (client fault)
55
+ * <p>The specified sample rate is not valid.</p>
56
+ *
57
+ * @throws {@link InvalidSnsTopicArnException} (client fault)
58
+ * <p>The provided SNS topic ARN is invalid. Please provide a valid SNS
59
+ * topic ARN and try again.</p>
60
+ *
61
+ * @throws {@link InvalidSsmlException} (client fault)
62
+ * <p>The SSML you provided is invalid. Verify the SSML syntax, spelling
63
+ * of tags and values, and then try again.</p>
64
+ *
65
+ * @throws {@link LanguageNotSupportedException} (client fault)
66
+ * <p>The language specified is not currently supported by Amazon Polly in this
67
+ * capacity.</p>
68
+ *
69
+ * @throws {@link LexiconNotFoundException} (client fault)
70
+ * <p>Amazon Polly can't find the specified lexicon. This could be caused by a
71
+ * lexicon that is missing, its name is misspelled or specifying a lexicon
72
+ * that is in a different region.</p>
73
+ * <p>Verify that the lexicon exists, is in the region (see <a>ListLexicons</a>) and that you spelled its name is spelled
74
+ * correctly. Then try again.</p>
75
+ *
76
+ * @throws {@link MarksNotSupportedForFormatException} (client fault)
77
+ * <p>Speech marks are not supported for the <code>OutputFormat</code>
78
+ * selected. Speech marks are only available for content in <code>json</code>
79
+ * format.</p>
80
+ *
81
+ * @throws {@link ServiceFailureException} (server fault)
82
+ * <p>An unknown condition has caused a service failure.</p>
83
+ *
84
+ * @throws {@link SsmlMarksNotSupportedForTextTypeException} (client fault)
85
+ * <p>SSML speech marks are not supported for plain text-type
86
+ * input.</p>
87
+ *
88
+ * @throws {@link TextLengthExceededException} (client fault)
89
+ * <p>The value of the "Text" parameter is longer than the accepted
90
+ * limits. For the <code>SynthesizeSpeech</code> API, the limit for input
91
+ * text is a maximum of 6000 characters total, of which no more than 3000 can
92
+ * be billed characters. For the <code>StartSpeechSynthesisTask</code> API,
93
+ * the maximum is 200,000 characters, of which no more than 100,000 can be
94
+ * billed characters. SSML tags are not counted as billed
95
+ * characters.</p>
96
+ *
97
+ *
41
98
  */
42
99
  export declare class StartSpeechSynthesisTaskCommand extends $Command<StartSpeechSynthesisTaskCommandInput, StartSpeechSynthesisTaskCommandOutput, PollyClientResolvedConfig> {
43
100
  readonly input: StartSpeechSynthesisTaskCommandInput;
package/dist-types/commands/SynthesizeSpeechCommand.d.ts CHANGED
@@ -33,6 +33,51 @@ export interface SynthesizeSpeechCommandOutput extends __WithSdkStreamMixin<Synt
33
33
  * @see {@link SynthesizeSpeechCommandOutput} for command's `response` shape.
34
34
  * @see {@link PollyClientResolvedConfig | config} for PollyClient's `config` shape.
35
35
  *
36
+ * @throws {@link EngineNotSupportedException} (client fault)
37
+ * <p>This engine is not compatible with the voice that you have designated.
38
+ * Choose a new voice that is compatible with the engine or change the engine
39
+ * and restart the operation.</p>
40
+ *
41
+ * @throws {@link InvalidSampleRateException} (client fault)
42
+ * <p>The specified sample rate is not valid.</p>
43
+ *
44
+ * @throws {@link InvalidSsmlException} (client fault)
45
+ * <p>The SSML you provided is invalid. Verify the SSML syntax, spelling
46
+ * of tags and values, and then try again.</p>
47
+ *
48
+ * @throws {@link LanguageNotSupportedException} (client fault)
49
+ * <p>The language specified is not currently supported by Amazon Polly in this
50
+ * capacity.</p>
51
+ *
52
+ * @throws {@link LexiconNotFoundException} (client fault)
53
+ * <p>Amazon Polly can't find the specified lexicon. This could be caused by a
54
+ * lexicon that is missing, its name is misspelled or specifying a lexicon
55
+ * that is in a different region.</p>
56
+ * <p>Verify that the lexicon exists, is in the region (see <a>ListLexicons</a>) and that you spelled its name is spelled
57
+ * correctly. Then try again.</p>
58
+ *
59
+ * @throws {@link MarksNotSupportedForFormatException} (client fault)
60
+ * <p>Speech marks are not supported for the <code>OutputFormat</code>
61
+ * selected. Speech marks are only available for content in <code>json</code>
62
+ * format.</p>
63
+ *
64
+ * @throws {@link ServiceFailureException} (server fault)
65
+ * <p>An unknown condition has caused a service failure.</p>
66
+ *
67
+ * @throws {@link SsmlMarksNotSupportedForTextTypeException} (client fault)
68
+ * <p>SSML speech marks are not supported for plain text-type
69
+ * input.</p>
70
+ *
71
+ * @throws {@link TextLengthExceededException} (client fault)
72
+ * <p>The value of the "Text" parameter is longer than the accepted
73
+ * limits. For the <code>SynthesizeSpeech</code> API, the limit for input
74
+ * text is a maximum of 6000 characters total, of which no more than 3000 can
75
+ * be billed characters. For the <code>StartSpeechSynthesisTask</code> API,
76
+ * the maximum is 200,000 characters, of which no more than 100,000 can be
77
+ * billed characters. SSML tags are not counted as billed
78
+ * characters.</p>
79
+ *
80
+ *
36
81
  * @example To synthesize speech
37
82
  * ```javascript
38
83
  * // Synthesizes plain text or SSML into a file of human-like speech.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-polly",
3
3
  "description": "AWS SDK for JavaScript Polly Client for Node.js, Browser and React Native",
4
- "version": "3.289.0",
4
+ "version": "3.292.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,57 +20,52 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.289.0",
24
- "@aws-sdk/config-resolver": "3.289.0",
25
- "@aws-sdk/credential-provider-node": "3.289.0",
26
- "@aws-sdk/fetch-http-handler": "3.289.0",
27
- "@aws-sdk/hash-node": "3.289.0",
28
- "@aws-sdk/invalid-dependency": "3.289.0",
29
- "@aws-sdk/middleware-content-length": "3.289.0",
30
- "@aws-sdk/middleware-endpoint": "3.289.0",
31
- "@aws-sdk/middleware-host-header": "3.289.0",
32
- "@aws-sdk/middleware-logger": "3.289.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
- "@aws-sdk/middleware-retry": "3.289.0",
35
- "@aws-sdk/middleware-serde": "3.289.0",
36
- "@aws-sdk/middleware-signing": "3.289.0",
37
- "@aws-sdk/middleware-stack": "3.289.0",
38
- "@aws-sdk/middleware-user-agent": "3.289.0",
39
- "@aws-sdk/node-config-provider": "3.289.0",
40
- "@aws-sdk/node-http-handler": "3.289.0",
41
- "@aws-sdk/protocol-http": "3.289.0",
42
- "@aws-sdk/smithy-client": "3.289.0",
43
- "@aws-sdk/types": "3.289.0",
44
- "@aws-sdk/url-parser": "3.289.0",
45
- "@aws-sdk/util-base64": "3.208.0",
46
- "@aws-sdk/util-body-length-browser": "3.188.0",
47
- "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
- "@aws-sdk/util-endpoints": "3.289.0",
51
- "@aws-sdk/util-retry": "3.289.0",
52
- "@aws-sdk/util-stream-browser": "3.289.0",
53
- "@aws-sdk/util-stream-node": "3.289.0",
54
- "@aws-sdk/util-user-agent-browser": "3.289.0",
55
- "@aws-sdk/util-user-agent-node": "3.289.0",
56
- "@aws-sdk/util-utf8": "3.254.0",
23
+ "@aws-sdk/client-sts": "3.292.0",
24
+ "@aws-sdk/config-resolver": "3.292.0",
25
+ "@aws-sdk/credential-provider-node": "3.292.0",
26
+ "@aws-sdk/fetch-http-handler": "3.292.0",
27
+ "@aws-sdk/hash-node": "3.292.0",
28
+ "@aws-sdk/invalid-dependency": "3.292.0",
29
+ "@aws-sdk/middleware-content-length": "3.292.0",
30
+ "@aws-sdk/middleware-endpoint": "3.292.0",
31
+ "@aws-sdk/middleware-host-header": "3.292.0",
32
+ "@aws-sdk/middleware-logger": "3.292.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.292.0",
34
+ "@aws-sdk/middleware-retry": "3.292.0",
35
+ "@aws-sdk/middleware-serde": "3.292.0",
36
+ "@aws-sdk/middleware-signing": "3.292.0",
37
+ "@aws-sdk/middleware-stack": "3.292.0",
38
+ "@aws-sdk/middleware-user-agent": "3.292.0",
39
+ "@aws-sdk/node-config-provider": "3.292.0",
40
+ "@aws-sdk/node-http-handler": "3.292.0",
41
+ "@aws-sdk/protocol-http": "3.292.0",
42
+ "@aws-sdk/smithy-client": "3.292.0",
43
+ "@aws-sdk/types": "3.292.0",
44
+ "@aws-sdk/url-parser": "3.292.0",
45
+ "@aws-sdk/util-base64": "3.292.0",
46
+ "@aws-sdk/util-body-length-browser": "3.292.0",
47
+ "@aws-sdk/util-body-length-node": "3.292.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.292.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.292.0",
50
+ "@aws-sdk/util-endpoints": "3.292.0",
51
+ "@aws-sdk/util-retry": "3.292.0",
52
+ "@aws-sdk/util-stream-browser": "3.292.0",
53
+ "@aws-sdk/util-stream-node": "3.292.0",
54
+ "@aws-sdk/util-user-agent-browser": "3.292.0",
55
+ "@aws-sdk/util-user-agent-node": "3.292.0",
56
+ "@aws-sdk/util-utf8": "3.292.0",
57
57
  "tslib": "^2.3.1"
58
58
  },
59
59
  "devDependencies": {
60
- "@aws-sdk/service-client-documentation-generator": "3.208.0",
60
+ "@aws-sdk/service-client-documentation-generator": "3.292.0",
61
61
  "@tsconfig/node14": "1.0.3",
62
62
  "@types/node": "^14.14.31",
63
63
  "concurrently": "7.0.0",
64
64
  "downlevel-dts": "0.10.1",
65
65
  "rimraf": "3.0.2",
66
- "typedoc": "0.19.2",
66
+ "typedoc": "0.23.23",
67
67
  "typescript": "~4.6.2"
68
68
  },
69
- "overrides": {
70
- "typedoc": {
71
- "typescript": "~4.6.2"
72
- }
73
- },
74
69
  "engines": {
75
70
  "node": ">=14.0.0"
76
71
  },