@aws-sdk/client-translate 3.438.0 → 3.441.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.
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.TranslateDocumentResponseFilterSensitiveLog = exports.TranslatedDocumentFilterSensitiveLog = exports.TranslateDocumentRequestFilterSensitiveLog = exports.DocumentFilterSensitiveLog = exports.ImportTerminologyRequestFilterSensitiveLog = exports.TerminologyDataFilterSensitiveLog = exports.TextSizeLimitExceededException = exports.DetectedLanguageLowConfidenceException = exports.ServiceUnavailableException = exports.UnsupportedLanguagePairException = exports.InvalidFilterException = exports.UnsupportedDisplayLanguageCodeException = exports.DisplayLanguageCode = exports.MergeStrategy = exports.Directionality = exports.TerminologyDataFormat = exports.Profanity = exports.Formality = exports.JobStatus = exports.ResourceNotFoundException = exports.TooManyTagsException = exports.TooManyRequestsException = exports.LimitExceededException = exports.InvalidRequestException = exports.InvalidParameterValueException = exports.InternalServerException = exports.ParallelDataStatus = exports.ParallelDataFormat = exports.EncryptionKeyType = exports.ConflictException = exports.ConcurrentModificationException = void 0;
3
+ exports.TranslateDocumentResponseFilterSensitiveLog = exports.TranslatedDocumentFilterSensitiveLog = exports.TranslateDocumentRequestFilterSensitiveLog = exports.DocumentFilterSensitiveLog = exports.ImportTerminologyRequestFilterSensitiveLog = exports.TerminologyDataFilterSensitiveLog = exports.TextSizeLimitExceededException = exports.DetectedLanguageLowConfidenceException = exports.ServiceUnavailableException = exports.UnsupportedLanguagePairException = exports.InvalidFilterException = exports.UnsupportedDisplayLanguageCodeException = exports.DisplayLanguageCode = exports.MergeStrategy = exports.Directionality = exports.TerminologyDataFormat = exports.Profanity = exports.Formality = exports.Brevity = exports.JobStatus = exports.ResourceNotFoundException = exports.TooManyTagsException = exports.TooManyRequestsException = exports.LimitExceededException = exports.InvalidRequestException = exports.InvalidParameterValueException = exports.InternalServerException = exports.ParallelDataStatus = exports.ParallelDataFormat = exports.EncryptionKeyType = exports.ConflictException = exports.ConcurrentModificationException = void 0;
4
4
  const smithy_client_1 = require("@smithy/smithy-client");
5
5
  const TranslateServiceException_1 = require("./TranslateServiceException");
6
6
  class ConcurrentModificationException extends TranslateServiceException_1.TranslateServiceException {
@@ -153,6 +153,9 @@ exports.JobStatus = {
153
153
  STOP_REQUESTED: "STOP_REQUESTED",
154
154
  SUBMITTED: "SUBMITTED",
155
155
  };
156
+ exports.Brevity = {
157
+ ON: "ON",
158
+ };
156
159
  exports.Formality = {
157
160
  FORMAL: "FORMAL",
158
161
  INFORMAL: "INFORMAL",
@@ -141,6 +141,9 @@ export const JobStatus = {
141
141
  STOP_REQUESTED: "STOP_REQUESTED",
142
142
  SUBMITTED: "SUBMITTED",
143
143
  };
144
+ export const Brevity = {
145
+ ON: "ON",
146
+ };
144
147
  export const Formality = {
145
148
  FORMAL: "FORMAL",
146
149
  INFORMAL: "INFORMAL",
@@ -37,8 +37,8 @@ export interface CreateParallelDataCommandOutput extends CreateParallelDataRespo
37
37
  * Name: "STRING_VALUE", // required
38
38
  * Description: "STRING_VALUE",
39
39
  * ParallelDataConfig: { // ParallelDataConfig
40
- * S3Uri: "STRING_VALUE", // required
41
- * Format: "TSV" || "CSV" || "TMX", // required
40
+ * S3Uri: "STRING_VALUE",
41
+ * Format: "TSV" || "CSV" || "TMX",
42
42
  * },
43
43
  * EncryptionKey: { // EncryptionKey
44
44
  * Type: "KMS", // required
@@ -74,6 +74,7 @@ export interface DescribeTextTranslationJobCommandOutput extends DescribeTextTra
74
74
  * // Settings: { // TranslationSettings
75
75
  * // Formality: "FORMAL" || "INFORMAL",
76
76
  * // Profanity: "MASK",
77
+ * // Brevity: "ON",
77
78
  * // },
78
79
  * // },
79
80
  * // };
@@ -46,8 +46,8 @@ export interface GetParallelDataCommandOutput extends GetParallelDataResponse, _
46
46
  * // "STRING_VALUE",
47
47
  * // ],
48
48
  * // ParallelDataConfig: { // ParallelDataConfig
49
- * // S3Uri: "STRING_VALUE", // required
50
- * // Format: "TSV" || "CSV" || "TMX", // required
49
+ * // S3Uri: "STRING_VALUE",
50
+ * // Format: "TSV" || "CSV" || "TMX",
51
51
  * // },
52
52
  * // Message: "STRING_VALUE",
53
53
  * // ImportedDataSize: Number("long"),
@@ -48,8 +48,8 @@ export interface ListParallelDataCommandOutput extends ListParallelDataResponse,
48
48
  * // "STRING_VALUE",
49
49
  * // ],
50
50
  * // ParallelDataConfig: { // ParallelDataConfig
51
- * // S3Uri: "STRING_VALUE", // required
52
- * // Format: "TSV" || "CSV" || "TMX", // required
51
+ * // S3Uri: "STRING_VALUE",
52
+ * // Format: "TSV" || "CSV" || "TMX",
53
53
  * // },
54
54
  * // Message: "STRING_VALUE",
55
55
  * // ImportedDataSize: Number("long"),
@@ -81,6 +81,7 @@ export interface ListTextTranslationJobsCommandOutput extends ListTextTranslatio
81
81
  * // Settings: { // TranslationSettings
82
82
  * // Formality: "FORMAL" || "INFORMAL",
83
83
  * // Profanity: "MASK",
84
+ * // Brevity: "ON",
84
85
  * // },
85
86
  * // },
86
87
  * // ],
@@ -66,6 +66,7 @@ export interface StartTextTranslationJobCommandOutput extends StartTextTranslati
66
66
  * Settings: { // TranslationSettings
67
67
  * Formality: "FORMAL" || "INFORMAL",
68
68
  * Profanity: "MASK",
69
+ * Brevity: "ON",
69
70
  * },
70
71
  * };
71
72
  * const command = new StartTextTranslationJobCommand(input);
@@ -24,14 +24,12 @@ export interface TranslateDocumentCommandOutput extends TranslateDocumentRespons
24
24
  /**
25
25
  * @public
26
26
  * <p>Translates the input document from the source language to the target language.
27
- * This synchronous operation supports plain text or HTML for the input document.
27
+ * This synchronous operation supports text, HTML, or Word documents as the input document.
28
28
  *
29
29
  * <code>TranslateDocument</code> supports translations from English to any supported language,
30
30
  * and from any supported language to English. Therefore, specify either the source language code
31
31
  * or the target language code as “en” (English).
32
32
  * </p>
33
- * <p>
34
- * <code>TranslateDocument</code> does not support language auto-detection. </p>
35
33
  * <p> If you set the <code>Formality</code> parameter, the request will fail if the target language does
36
34
  * not support formality. For a list of target languages that support formality, see
37
35
  * <a href="https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-formality.html">Setting formality</a>.
@@ -55,6 +53,7 @@ export interface TranslateDocumentCommandOutput extends TranslateDocumentRespons
55
53
  * Settings: { // TranslationSettings
56
54
  * Formality: "FORMAL" || "INFORMAL",
57
55
  * Profanity: "MASK",
56
+ * Brevity: "ON",
58
57
  * },
59
58
  * };
60
59
  * const command = new TranslateDocumentCommand(input);
@@ -79,6 +78,7 @@ export interface TranslateDocumentCommandOutput extends TranslateDocumentRespons
79
78
  * // AppliedSettings: { // TranslationSettings
80
79
  * // Formality: "FORMAL" || "INFORMAL",
81
80
  * // Profanity: "MASK",
81
+ * // Brevity: "ON",
82
82
  * // },
83
83
  * // };
84
84
  *
@@ -41,6 +41,7 @@ export interface TranslateTextCommandOutput extends TranslateTextResponse, __Met
41
41
  * Settings: { // TranslationSettings
42
42
  * Formality: "FORMAL" || "INFORMAL",
43
43
  * Profanity: "MASK",
44
+ * Brevity: "ON",
44
45
  * },
45
46
  * };
46
47
  * const command = new TranslateTextCommand(input);
@@ -63,6 +64,7 @@ export interface TranslateTextCommandOutput extends TranslateTextResponse, __Met
63
64
  * // AppliedSettings: { // TranslationSettings
64
65
  * // Formality: "FORMAL" || "INFORMAL",
65
66
  * // Profanity: "MASK",
67
+ * // Brevity: "ON",
66
68
  * // },
67
69
  * // };
68
70
  *
@@ -35,8 +35,8 @@ export interface UpdateParallelDataCommandOutput extends UpdateParallelDataRespo
35
35
  * Name: "STRING_VALUE", // required
36
36
  * Description: "STRING_VALUE",
37
37
  * ParallelDataConfig: { // ParallelDataConfig
38
- * S3Uri: "STRING_VALUE", // required
39
- * Format: "TSV" || "CSV" || "TMX", // required
38
+ * S3Uri: "STRING_VALUE",
39
+ * Format: "TSV" || "CSV" || "TMX",
40
40
  * },
41
41
  * ClientToken: "STRING_VALUE", // required
42
42
  * };
@@ -115,12 +115,12 @@ export interface ParallelDataConfig {
115
115
  * <p>The URI of the Amazon S3 folder that contains the parallel data input file. The folder
116
116
  * must be in the same Region as the API endpoint you are calling.</p>
117
117
  */
118
- S3Uri: string | undefined;
118
+ S3Uri?: string;
119
119
  /**
120
120
  * @public
121
121
  * <p>The format of the parallel data input file.</p>
122
122
  */
123
- Format: ParallelDataFormat | undefined;
123
+ Format?: ParallelDataFormat;
124
124
  }
125
125
  /**
126
126
  * @public
@@ -468,6 +468,17 @@ export interface OutputDataConfig {
468
468
  */
469
469
  EncryptionKey?: EncryptionKey;
470
470
  }
471
+ /**
472
+ * @public
473
+ * @enum
474
+ */
475
+ export declare const Brevity: {
476
+ readonly ON: "ON";
477
+ };
478
+ /**
479
+ * @public
480
+ */
481
+ export type Brevity = (typeof Brevity)[keyof typeof Brevity];
471
482
  /**
472
483
  * @public
473
484
  * @enum
@@ -493,13 +504,24 @@ export declare const Profanity: {
493
504
  export type Profanity = (typeof Profanity)[keyof typeof Profanity];
494
505
  /**
495
506
  * @public
496
- * <p>Settings to configure your translation output, including the option to set the formality
497
- * level of the output text and the option to mask profane words and phrases.</p>
507
+ * <p>Settings to configure your translation output. You can configure the following options:</p>
508
+ * <ul>
509
+ * <li>
510
+ * <p>Brevity: reduces the length of the translation output for most translations. Available for
511
+ * <code>TranslateText</code> only.</p>
512
+ * </li>
513
+ * <li>
514
+ * <p>Formality: sets the formality level of the translation output.</p>
515
+ * </li>
516
+ * <li>
517
+ * <p>Profanity: masks profane words and phrases in the translation output.</p>
518
+ * </li>
519
+ * </ul>
498
520
  */
499
521
  export interface TranslationSettings {
500
522
  /**
501
523
  * @public
502
- * <p>You can optionally specify the desired level of formality for translations
524
+ * <p>You can specify the desired level of formality for translations
503
525
  * to supported target languages. The formality
504
526
  * setting controls the level of formal language usage (also known as <a href="https://en.wikipedia.org/wiki/Register_(sociolinguistics)">register</a>) in the
505
527
  * translation output. You can set the value to informal or formal. If you don't specify a value for
@@ -513,7 +535,7 @@ export interface TranslationSettings {
513
535
  Formality?: Formality;
514
536
  /**
515
537
  * @public
516
- * <p>Enable the profanity setting if you want Amazon Translate to mask profane words and
538
+ * <p>You can enable the profanity setting if you want to mask profane words and
517
539
  * phrases in your translation output.</p>
518
540
  * <p>To mask profane words and phrases, Amazon Translate replaces them with the grawlix string
519
541
  * “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the
@@ -527,6 +549,17 @@ export interface TranslationSettings {
527
549
  * language.</p>
528
550
  */
529
551
  Profanity?: Profanity;
552
+ /**
553
+ * @public
554
+ * <p>When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when
555
+ * compared with the same translation with brevity turned off). By default, brevity is turned
556
+ * off.</p>
557
+ * <p>If you turn on brevity for a translation request with an unsupported language pair, the
558
+ * translation proceeds with the brevity setting turned off.</p>
559
+ * <p>For the language pairs that brevity supports, see <a href="https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-brevity">Using brevity</a> in the
560
+ * Amazon Translate Developer Guide.</p>
561
+ */
562
+ Brevity?: Brevity;
530
563
  }
531
564
  /**
532
565
  * @public
@@ -1464,8 +1497,18 @@ export interface StartTextTranslationJobRequest {
1464
1497
  ClientToken?: string;
1465
1498
  /**
1466
1499
  * @public
1467
- * <p>Settings to configure your translation output, including the option to set the formality
1468
- * level of the output text and the option to mask profane words and phrases.</p>
1500
+ * <p>Settings to configure your translation output. You can configure the following options:</p>
1501
+ * <ul>
1502
+ * <li>
1503
+ * <p>Brevity: not supported.</p>
1504
+ * </li>
1505
+ * <li>
1506
+ * <p>Formality: sets the formality level of the output text.</p>
1507
+ * </li>
1508
+ * <li>
1509
+ * <p>Profanity: masks profane words and phrases in your translation output.</p>
1510
+ * </li>
1511
+ * </ul>
1469
1512
  */
1470
1513
  Settings?: TranslationSettings;
1471
1514
  }
@@ -1664,10 +1707,16 @@ export interface TranslateDocumentRequest {
1664
1707
  TerminologyNames?: string[];
1665
1708
  /**
1666
1709
  * @public
1667
- * <p>The language code for the language of the source text. Do not use <code>auto</code>, because
1668
- * <code>TranslateDocument</code> does not support language auto-detection.
1669
- * For a list of supported language codes, see
1710
+ * <p>The language code for the language of the source text. For a list of supported language codes, see
1670
1711
  * <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
1712
+ * <p>To have Amazon Translate determine the source language of your text, you can specify
1713
+ * <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify
1714
+ * <code>auto</code>, Amazon Translate will call <a href="https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html">Amazon
1715
+ * Comprehend</a> to determine the source language.</p>
1716
+ * <note>
1717
+ * <p>If you specify <code>auto</code>, you must send the <code>TranslateDocument</code> request in a region that supports
1718
+ * Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported. </p>
1719
+ * </note>
1671
1720
  */
1672
1721
  SourceLanguageCode: string | undefined;
1673
1722
  /**
@@ -1679,8 +1728,18 @@ export interface TranslateDocumentRequest {
1679
1728
  TargetLanguageCode: string | undefined;
1680
1729
  /**
1681
1730
  * @public
1682
- * <p>Settings to configure your translation output, including the option to set the formality
1683
- * level of the output text and the option to mask profane words and phrases.</p>
1731
+ * <p>Settings to configure your translation output. You can configure the following options:</p>
1732
+ * <ul>
1733
+ * <li>
1734
+ * <p>Brevity: not supported.</p>
1735
+ * </li>
1736
+ * <li>
1737
+ * <p>Formality: sets the formality level of the output text.</p>
1738
+ * </li>
1739
+ * <li>
1740
+ * <p>Profanity: masks profane words and phrases in your translation output.</p>
1741
+ * </li>
1742
+ * </ul>
1684
1743
  */
1685
1744
  Settings?: TranslationSettings;
1686
1745
  }
@@ -1722,8 +1781,19 @@ export interface TranslateDocumentResponse {
1722
1781
  AppliedTerminologies?: AppliedTerminology[];
1723
1782
  /**
1724
1783
  * @public
1725
- * <p>Settings to configure your translation output, including the option to set the formality
1726
- * level of the output text and the option to mask profane words and phrases.</p>
1784
+ * <p>Settings to configure your translation output. You can configure the following options:</p>
1785
+ * <ul>
1786
+ * <li>
1787
+ * <p>Brevity: reduces the length of the translation output for most translations. Available for
1788
+ * <code>TranslateText</code> only.</p>
1789
+ * </li>
1790
+ * <li>
1791
+ * <p>Formality: sets the formality level of the translation output.</p>
1792
+ * </li>
1793
+ * <li>
1794
+ * <p>Profanity: masks profane words and phrases in the translation output.</p>
1795
+ * </li>
1796
+ * </ul>
1727
1797
  */
1728
1798
  AppliedSettings?: TranslationSettings;
1729
1799
  }
@@ -1804,8 +1874,18 @@ export interface TranslateTextRequest {
1804
1874
  TargetLanguageCode: string | undefined;
1805
1875
  /**
1806
1876
  * @public
1807
- * <p>Settings to configure your translation output, including the option to set the formality
1808
- * level of the output text and the option to mask profane words and phrases.</p>
1877
+ * <p>Settings to configure your translation output. You can configure the following options:</p>
1878
+ * <ul>
1879
+ * <li>
1880
+ * <p>Brevity: reduces the length of the translated output for most translations.</p>
1881
+ * </li>
1882
+ * <li>
1883
+ * <p>Formality: sets the formality level of the output text.</p>
1884
+ * </li>
1885
+ * <li>
1886
+ * <p>Profanity: masks profane words and phrases in your translation output.</p>
1887
+ * </li>
1888
+ * </ul>
1809
1889
  */
1810
1890
  Settings?: TranslationSettings;
1811
1891
  }
@@ -42,8 +42,8 @@ export declare const ParallelDataFormat: {
42
42
  export type ParallelDataFormat =
43
43
  (typeof ParallelDataFormat)[keyof typeof ParallelDataFormat];
44
44
  export interface ParallelDataConfig {
45
- S3Uri: string | undefined;
46
- Format: ParallelDataFormat | undefined;
45
+ S3Uri?: string;
46
+ Format?: ParallelDataFormat;
47
47
  }
48
48
  export interface Tag {
49
49
  Key: string | undefined;
@@ -162,6 +162,10 @@ export interface OutputDataConfig {
162
162
  S3Uri: string | undefined;
163
163
  EncryptionKey?: EncryptionKey;
164
164
  }
165
+ export declare const Brevity: {
166
+ readonly ON: "ON";
167
+ };
168
+ export type Brevity = (typeof Brevity)[keyof typeof Brevity];
165
169
  export declare const Formality: {
166
170
  readonly FORMAL: "FORMAL";
167
171
  readonly INFORMAL: "INFORMAL";
@@ -174,6 +178,7 @@ export type Profanity = (typeof Profanity)[keyof typeof Profanity];
174
178
  export interface TranslationSettings {
175
179
  Formality?: Formality;
176
180
  Profanity?: Profanity;
181
+ Brevity?: Brevity;
177
182
  }
178
183
  export interface TextTranslationJobProperties {
179
184
  JobId?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-translate",
3
3
  "description": "AWS SDK for JavaScript Translate Client for Node.js, Browser and React Native",
4
- "version": "3.438.0",
4
+ "version": "3.441.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",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.438.0",
25
- "@aws-sdk/core": "3.436.0",
26
- "@aws-sdk/credential-provider-node": "3.438.0",
24
+ "@aws-sdk/client-sts": "3.441.0",
25
+ "@aws-sdk/core": "3.441.0",
26
+ "@aws-sdk/credential-provider-node": "3.441.0",
27
27
  "@aws-sdk/middleware-host-header": "3.433.0",
28
28
  "@aws-sdk/middleware-logger": "3.433.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.433.0",