@aws-sdk/client-translate 3.379.1 → 3.385.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.
- package/dist-types/models/models_0.d.ts +185 -0
- package/package.json +5 -5
|
@@ -6,10 +6,12 @@ import { TranslateServiceException as __BaseException } from "./TranslateService
|
|
|
6
6
|
*/
|
|
7
7
|
export interface Term {
|
|
8
8
|
/**
|
|
9
|
+
* @public
|
|
9
10
|
* <p>The source text of the term being translated by the custom terminology.</p>
|
|
10
11
|
*/
|
|
11
12
|
SourceText?: string;
|
|
12
13
|
/**
|
|
14
|
+
* @public
|
|
13
15
|
* <p>The target text of the term being translated by the custom terminology.</p>
|
|
14
16
|
*/
|
|
15
17
|
TargetText?: string;
|
|
@@ -23,11 +25,13 @@ export interface Term {
|
|
|
23
25
|
*/
|
|
24
26
|
export interface AppliedTerminology {
|
|
25
27
|
/**
|
|
28
|
+
* @public
|
|
26
29
|
* <p>The name of the custom terminology applied to the input text by Amazon Translate for the translated
|
|
27
30
|
* text response.</p>
|
|
28
31
|
*/
|
|
29
32
|
Name?: string;
|
|
30
33
|
/**
|
|
34
|
+
* @public
|
|
31
35
|
* <p>The specific terms of the custom terminology applied to the input text by Amazon Translate for the
|
|
32
36
|
* translated text response. A maximum of 250 terms will be returned, and the specific terms
|
|
33
37
|
* applied will be the first 250 terms in the source text. </p>
|
|
@@ -78,10 +82,12 @@ export type EncryptionKeyType = (typeof EncryptionKeyType)[keyof typeof Encrypti
|
|
|
78
82
|
*/
|
|
79
83
|
export interface EncryptionKey {
|
|
80
84
|
/**
|
|
85
|
+
* @public
|
|
81
86
|
* <p>The type of encryption key used by Amazon Translate to encrypt this object.</p>
|
|
82
87
|
*/
|
|
83
88
|
Type: EncryptionKeyType | string | undefined;
|
|
84
89
|
/**
|
|
90
|
+
* @public
|
|
85
91
|
* <p>The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.</p>
|
|
86
92
|
*/
|
|
87
93
|
Id: string | undefined;
|
|
@@ -105,11 +111,13 @@ export type ParallelDataFormat = (typeof ParallelDataFormat)[keyof typeof Parall
|
|
|
105
111
|
*/
|
|
106
112
|
export interface ParallelDataConfig {
|
|
107
113
|
/**
|
|
114
|
+
* @public
|
|
108
115
|
* <p>The URI of the Amazon S3 folder that contains the parallel data input file. The folder
|
|
109
116
|
* must be in the same Region as the API endpoint you are calling.</p>
|
|
110
117
|
*/
|
|
111
118
|
S3Uri: string | undefined;
|
|
112
119
|
/**
|
|
120
|
+
* @public
|
|
113
121
|
* <p>The format of the parallel data input file.</p>
|
|
114
122
|
*/
|
|
115
123
|
Format: ParallelDataFormat | string | undefined;
|
|
@@ -120,11 +128,13 @@ export interface ParallelDataConfig {
|
|
|
120
128
|
*/
|
|
121
129
|
export interface Tag {
|
|
122
130
|
/**
|
|
131
|
+
* @public
|
|
123
132
|
* <p>The initial part of a key-value pair that forms a tag associated with a given resource.
|
|
124
133
|
* </p>
|
|
125
134
|
*/
|
|
126
135
|
Key: string | undefined;
|
|
127
136
|
/**
|
|
137
|
+
* @public
|
|
128
138
|
* <p> The second part of a key-value pair that forms a tag associated with a given resource.</p>
|
|
129
139
|
*/
|
|
130
140
|
Value: string | undefined;
|
|
@@ -134,28 +144,34 @@ export interface Tag {
|
|
|
134
144
|
*/
|
|
135
145
|
export interface CreateParallelDataRequest {
|
|
136
146
|
/**
|
|
147
|
+
* @public
|
|
137
148
|
* <p>A custom name for the parallel data resource in Amazon Translate. You must assign a name
|
|
138
149
|
* that is unique in the account and region.</p>
|
|
139
150
|
*/
|
|
140
151
|
Name: string | undefined;
|
|
141
152
|
/**
|
|
153
|
+
* @public
|
|
142
154
|
* <p>A custom description for the parallel data resource in Amazon Translate.</p>
|
|
143
155
|
*/
|
|
144
156
|
Description?: string;
|
|
145
157
|
/**
|
|
158
|
+
* @public
|
|
146
159
|
* <p>Specifies the format and S3 location of the parallel data input file.</p>
|
|
147
160
|
*/
|
|
148
161
|
ParallelDataConfig: ParallelDataConfig | undefined;
|
|
149
162
|
/**
|
|
163
|
+
* @public
|
|
150
164
|
* <p>The encryption key used to encrypt this object.</p>
|
|
151
165
|
*/
|
|
152
166
|
EncryptionKey?: EncryptionKey;
|
|
153
167
|
/**
|
|
168
|
+
* @public
|
|
154
169
|
* <p>A unique identifier for the request. This token is automatically generated when you use
|
|
155
170
|
* Amazon Translate through an AWS SDK.</p>
|
|
156
171
|
*/
|
|
157
172
|
ClientToken?: string;
|
|
158
173
|
/**
|
|
174
|
+
* @public
|
|
159
175
|
* <p>Tags to be associated with this resource. A tag is a key-value pair that
|
|
160
176
|
* adds metadata to a resource. Each tag key for the resource must be unique.
|
|
161
177
|
* For more information, see <a href="https://docs.aws.amazon.com/translate/latest/dg/tagging.html">
|
|
@@ -183,10 +199,12 @@ export type ParallelDataStatus = (typeof ParallelDataStatus)[keyof typeof Parall
|
|
|
183
199
|
*/
|
|
184
200
|
export interface CreateParallelDataResponse {
|
|
185
201
|
/**
|
|
202
|
+
* @public
|
|
186
203
|
* <p>The custom name that you assigned to the parallel data resource.</p>
|
|
187
204
|
*/
|
|
188
205
|
Name?: string;
|
|
189
206
|
/**
|
|
207
|
+
* @public
|
|
190
208
|
* <p>The status of the parallel data resource. When the resource is ready for you to use, the
|
|
191
209
|
* status is <code>ACTIVE</code>.</p>
|
|
192
210
|
*/
|
|
@@ -279,6 +297,7 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
279
297
|
*/
|
|
280
298
|
export interface DeleteParallelDataRequest {
|
|
281
299
|
/**
|
|
300
|
+
* @public
|
|
282
301
|
* <p>The name of the parallel data resource that is being deleted.</p>
|
|
283
302
|
*/
|
|
284
303
|
Name: string | undefined;
|
|
@@ -288,10 +307,12 @@ export interface DeleteParallelDataRequest {
|
|
|
288
307
|
*/
|
|
289
308
|
export interface DeleteParallelDataResponse {
|
|
290
309
|
/**
|
|
310
|
+
* @public
|
|
291
311
|
* <p>The name of the parallel data resource that is being deleted.</p>
|
|
292
312
|
*/
|
|
293
313
|
Name?: string;
|
|
294
314
|
/**
|
|
315
|
+
* @public
|
|
295
316
|
* <p>The status of the parallel data deletion.</p>
|
|
296
317
|
*/
|
|
297
318
|
Status?: ParallelDataStatus | string;
|
|
@@ -316,6 +337,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
316
337
|
*/
|
|
317
338
|
export interface DeleteTerminologyRequest {
|
|
318
339
|
/**
|
|
340
|
+
* @public
|
|
319
341
|
* <p>The name of the custom terminology being deleted. </p>
|
|
320
342
|
*/
|
|
321
343
|
Name: string | undefined;
|
|
@@ -325,6 +347,7 @@ export interface DeleteTerminologyRequest {
|
|
|
325
347
|
*/
|
|
326
348
|
export interface DescribeTextTranslationJobRequest {
|
|
327
349
|
/**
|
|
350
|
+
* @public
|
|
328
351
|
* <p>The identifier that Amazon Translate generated for the job. The <a>StartTextTranslationJob</a> operation returns this identifier in its
|
|
329
352
|
* response.</p>
|
|
330
353
|
*/
|
|
@@ -336,12 +359,14 @@ export interface DescribeTextTranslationJobRequest {
|
|
|
336
359
|
*/
|
|
337
360
|
export interface InputDataConfig {
|
|
338
361
|
/**
|
|
362
|
+
* @public
|
|
339
363
|
* <p>The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the
|
|
340
364
|
* files in the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are
|
|
341
365
|
* calling.</p>
|
|
342
366
|
*/
|
|
343
367
|
S3Uri: string | undefined;
|
|
344
368
|
/**
|
|
369
|
+
* @public
|
|
345
370
|
* <p>Describes the format of the data that you submit to Amazon Translate as input. You can
|
|
346
371
|
* specify one of the following multipurpose internet mail extension (MIME) types:</p>
|
|
347
372
|
* <ul>
|
|
@@ -394,14 +419,17 @@ export interface InputDataConfig {
|
|
|
394
419
|
*/
|
|
395
420
|
export interface JobDetails {
|
|
396
421
|
/**
|
|
422
|
+
* @public
|
|
397
423
|
* <p>The number of documents successfully processed during a translation job.</p>
|
|
398
424
|
*/
|
|
399
425
|
TranslatedDocumentsCount?: number;
|
|
400
426
|
/**
|
|
427
|
+
* @public
|
|
401
428
|
* <p>The number of documents that could not be processed during a translation job.</p>
|
|
402
429
|
*/
|
|
403
430
|
DocumentsWithErrorsCount?: number;
|
|
404
431
|
/**
|
|
432
|
+
* @public
|
|
405
433
|
* <p>The number of documents used as input in a translation job.</p>
|
|
406
434
|
*/
|
|
407
435
|
InputDocumentsCount?: number;
|
|
@@ -429,11 +457,13 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
|
|
|
429
457
|
*/
|
|
430
458
|
export interface OutputDataConfig {
|
|
431
459
|
/**
|
|
460
|
+
* @public
|
|
432
461
|
* <p>The URI of the S3 folder that contains a translation job's output file. The folder must
|
|
433
462
|
* be in the same Region as the API endpoint that you are calling.</p>
|
|
434
463
|
*/
|
|
435
464
|
S3Uri: string | undefined;
|
|
436
465
|
/**
|
|
466
|
+
* @public
|
|
437
467
|
* <p>The encryption key used to encrypt this object.</p>
|
|
438
468
|
*/
|
|
439
469
|
EncryptionKey?: EncryptionKey;
|
|
@@ -468,6 +498,7 @@ export type Profanity = (typeof Profanity)[keyof typeof Profanity];
|
|
|
468
498
|
*/
|
|
469
499
|
export interface TranslationSettings {
|
|
470
500
|
/**
|
|
501
|
+
* @public
|
|
471
502
|
* <p>You can optionally specify the desired level of formality for translations
|
|
472
503
|
* to supported target languages. The formality
|
|
473
504
|
* setting controls the level of formal language usage (also known as <a href="https://en.wikipedia.org/wiki/Register_(sociolinguistics)">register</a>) in the
|
|
@@ -481,6 +512,7 @@ export interface TranslationSettings {
|
|
|
481
512
|
*/
|
|
482
513
|
Formality?: Formality | string;
|
|
483
514
|
/**
|
|
515
|
+
* @public
|
|
484
516
|
* <p>Enable the profanity setting if you want Amazon Translate to mask profane words and
|
|
485
517
|
* phrases in your translation output.</p>
|
|
486
518
|
* <p>To mask profane words and phrases, Amazon Translate replaces them with the grawlix string
|
|
@@ -502,69 +534,84 @@ export interface TranslationSettings {
|
|
|
502
534
|
*/
|
|
503
535
|
export interface TextTranslationJobProperties {
|
|
504
536
|
/**
|
|
537
|
+
* @public
|
|
505
538
|
* <p>The ID of the translation job.</p>
|
|
506
539
|
*/
|
|
507
540
|
JobId?: string;
|
|
508
541
|
/**
|
|
542
|
+
* @public
|
|
509
543
|
* <p>The user-defined name of the translation job.</p>
|
|
510
544
|
*/
|
|
511
545
|
JobName?: string;
|
|
512
546
|
/**
|
|
547
|
+
* @public
|
|
513
548
|
* <p>The status of the translation job.</p>
|
|
514
549
|
*/
|
|
515
550
|
JobStatus?: JobStatus | string;
|
|
516
551
|
/**
|
|
552
|
+
* @public
|
|
517
553
|
* <p>The number of documents successfully and unsuccessfully processed during the translation
|
|
518
554
|
* job.</p>
|
|
519
555
|
*/
|
|
520
556
|
JobDetails?: JobDetails;
|
|
521
557
|
/**
|
|
558
|
+
* @public
|
|
522
559
|
* <p>The language code of the language of the source text. The language must be a language
|
|
523
560
|
* supported by Amazon Translate.</p>
|
|
524
561
|
*/
|
|
525
562
|
SourceLanguageCode?: string;
|
|
526
563
|
/**
|
|
564
|
+
* @public
|
|
527
565
|
* <p>The language code of the language of the target text. The language must be a language
|
|
528
566
|
* supported by Amazon Translate.</p>
|
|
529
567
|
*/
|
|
530
568
|
TargetLanguageCodes?: string[];
|
|
531
569
|
/**
|
|
570
|
+
* @public
|
|
532
571
|
* <p>A list containing the names of the terminologies applied to a translation job. Only one
|
|
533
572
|
* terminology can be applied per <a>StartTextTranslationJob</a> request at this
|
|
534
573
|
* time.</p>
|
|
535
574
|
*/
|
|
536
575
|
TerminologyNames?: string[];
|
|
537
576
|
/**
|
|
577
|
+
* @public
|
|
538
578
|
* <p>A list containing the names of the parallel data resources applied to the translation
|
|
539
579
|
* job.</p>
|
|
540
580
|
*/
|
|
541
581
|
ParallelDataNames?: string[];
|
|
542
582
|
/**
|
|
583
|
+
* @public
|
|
543
584
|
* <p>An explanation of any errors that may have occurred during the translation job.</p>
|
|
544
585
|
*/
|
|
545
586
|
Message?: string;
|
|
546
587
|
/**
|
|
588
|
+
* @public
|
|
547
589
|
* <p>The time at which the translation job was submitted.</p>
|
|
548
590
|
*/
|
|
549
591
|
SubmittedTime?: Date;
|
|
550
592
|
/**
|
|
593
|
+
* @public
|
|
551
594
|
* <p>The time at which the translation job ended.</p>
|
|
552
595
|
*/
|
|
553
596
|
EndTime?: Date;
|
|
554
597
|
/**
|
|
598
|
+
* @public
|
|
555
599
|
* <p>The input configuration properties that were specified when the job was requested.</p>
|
|
556
600
|
*/
|
|
557
601
|
InputDataConfig?: InputDataConfig;
|
|
558
602
|
/**
|
|
603
|
+
* @public
|
|
559
604
|
* <p>The output configuration properties that were specified when the job was requested.</p>
|
|
560
605
|
*/
|
|
561
606
|
OutputDataConfig?: OutputDataConfig;
|
|
562
607
|
/**
|
|
608
|
+
* @public
|
|
563
609
|
* <p>The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role
|
|
564
610
|
* that granted Amazon Translate read access to the job's input data.</p>
|
|
565
611
|
*/
|
|
566
612
|
DataAccessRoleArn?: string;
|
|
567
613
|
/**
|
|
614
|
+
* @public
|
|
568
615
|
* <p>Settings that modify the translation output.</p>
|
|
569
616
|
*/
|
|
570
617
|
Settings?: TranslationSettings;
|
|
@@ -574,6 +621,7 @@ export interface TextTranslationJobProperties {
|
|
|
574
621
|
*/
|
|
575
622
|
export interface DescribeTextTranslationJobResponse {
|
|
576
623
|
/**
|
|
624
|
+
* @public
|
|
577
625
|
* <p>An object that contains the properties associated with an asynchronous batch translation
|
|
578
626
|
* job.</p>
|
|
579
627
|
*/
|
|
@@ -584,6 +632,7 @@ export interface DescribeTextTranslationJobResponse {
|
|
|
584
632
|
*/
|
|
585
633
|
export interface GetParallelDataRequest {
|
|
586
634
|
/**
|
|
635
|
+
* @public
|
|
587
636
|
* <p>The name of the parallel data resource that is being retrieved.</p>
|
|
588
637
|
*/
|
|
589
638
|
Name: string | undefined;
|
|
@@ -595,10 +644,12 @@ export interface GetParallelDataRequest {
|
|
|
595
644
|
*/
|
|
596
645
|
export interface ParallelDataDataLocation {
|
|
597
646
|
/**
|
|
647
|
+
* @public
|
|
598
648
|
* <p>Describes the repository that contains the parallel data input file.</p>
|
|
599
649
|
*/
|
|
600
650
|
RepositoryType: string | undefined;
|
|
601
651
|
/**
|
|
652
|
+
* @public
|
|
602
653
|
* <p>The Amazon S3 location of the parallel data input file. The location is returned as a
|
|
603
654
|
* presigned URL to that has a 30-minute expiration.</p>
|
|
604
655
|
*
|
|
@@ -620,40 +671,49 @@ export interface ParallelDataDataLocation {
|
|
|
620
671
|
*/
|
|
621
672
|
export interface ParallelDataProperties {
|
|
622
673
|
/**
|
|
674
|
+
* @public
|
|
623
675
|
* <p>The custom name assigned to the parallel data resource.</p>
|
|
624
676
|
*/
|
|
625
677
|
Name?: string;
|
|
626
678
|
/**
|
|
679
|
+
* @public
|
|
627
680
|
* <p>The Amazon Resource Name (ARN) of the parallel data resource.</p>
|
|
628
681
|
*/
|
|
629
682
|
Arn?: string;
|
|
630
683
|
/**
|
|
684
|
+
* @public
|
|
631
685
|
* <p>The description assigned to the parallel data resource.</p>
|
|
632
686
|
*/
|
|
633
687
|
Description?: string;
|
|
634
688
|
/**
|
|
689
|
+
* @public
|
|
635
690
|
* <p>The status of the parallel data resource. When the parallel data is ready for you to use,
|
|
636
691
|
* the status is <code>ACTIVE</code>.</p>
|
|
637
692
|
*/
|
|
638
693
|
Status?: ParallelDataStatus | string;
|
|
639
694
|
/**
|
|
695
|
+
* @public
|
|
640
696
|
* <p>The source language of the translations in the parallel data file.</p>
|
|
641
697
|
*/
|
|
642
698
|
SourceLanguageCode?: string;
|
|
643
699
|
/**
|
|
700
|
+
* @public
|
|
644
701
|
* <p>The language codes for the target languages available in the parallel data file. All
|
|
645
702
|
* possible target languages are returned as an array.</p>
|
|
646
703
|
*/
|
|
647
704
|
TargetLanguageCodes?: string[];
|
|
648
705
|
/**
|
|
706
|
+
* @public
|
|
649
707
|
* <p>Specifies the format and S3 location of the parallel data input file.</p>
|
|
650
708
|
*/
|
|
651
709
|
ParallelDataConfig?: ParallelDataConfig;
|
|
652
710
|
/**
|
|
711
|
+
* @public
|
|
653
712
|
* <p>Additional information from Amazon Translate about the parallel data resource. </p>
|
|
654
713
|
*/
|
|
655
714
|
Message?: string;
|
|
656
715
|
/**
|
|
716
|
+
* @public
|
|
657
717
|
* <p>The number of UTF-8 characters that Amazon Translate imported from the parallel data input
|
|
658
718
|
* file. This number includes only the characters in your translation examples. It does not
|
|
659
719
|
* include characters that are used to format your file. For example, if you provided a
|
|
@@ -661,36 +721,44 @@ export interface ParallelDataProperties {
|
|
|
661
721
|
*/
|
|
662
722
|
ImportedDataSize?: number;
|
|
663
723
|
/**
|
|
724
|
+
* @public
|
|
664
725
|
* <p>The number of records successfully imported from the parallel data input file.</p>
|
|
665
726
|
*/
|
|
666
727
|
ImportedRecordCount?: number;
|
|
667
728
|
/**
|
|
729
|
+
* @public
|
|
668
730
|
* <p>The number of records unsuccessfully imported from the parallel data input file.</p>
|
|
669
731
|
*/
|
|
670
732
|
FailedRecordCount?: number;
|
|
671
733
|
/**
|
|
734
|
+
* @public
|
|
672
735
|
* <p>The number of items in the input file that Amazon Translate skipped when you created or
|
|
673
736
|
* updated the parallel data resource. For example, Amazon Translate skips empty records, empty
|
|
674
737
|
* target texts, and empty lines.</p>
|
|
675
738
|
*/
|
|
676
739
|
SkippedRecordCount?: number;
|
|
677
740
|
/**
|
|
741
|
+
* @public
|
|
678
742
|
* <p>The encryption key used to encrypt this object.</p>
|
|
679
743
|
*/
|
|
680
744
|
EncryptionKey?: EncryptionKey;
|
|
681
745
|
/**
|
|
746
|
+
* @public
|
|
682
747
|
* <p>The time at which the parallel data resource was created.</p>
|
|
683
748
|
*/
|
|
684
749
|
CreatedAt?: Date;
|
|
685
750
|
/**
|
|
751
|
+
* @public
|
|
686
752
|
* <p>The time at which the parallel data resource was last updated.</p>
|
|
687
753
|
*/
|
|
688
754
|
LastUpdatedAt?: Date;
|
|
689
755
|
/**
|
|
756
|
+
* @public
|
|
690
757
|
* <p>The status of the most recent update attempt for the parallel data resource.</p>
|
|
691
758
|
*/
|
|
692
759
|
LatestUpdateAttemptStatus?: ParallelDataStatus | string;
|
|
693
760
|
/**
|
|
761
|
+
* @public
|
|
694
762
|
* <p>The time that the most recent update was attempted.</p>
|
|
695
763
|
*/
|
|
696
764
|
LatestUpdateAttemptAt?: Date;
|
|
@@ -700,10 +768,12 @@ export interface ParallelDataProperties {
|
|
|
700
768
|
*/
|
|
701
769
|
export interface GetParallelDataResponse {
|
|
702
770
|
/**
|
|
771
|
+
* @public
|
|
703
772
|
* <p>The properties of the parallel data resource that is being retrieved.</p>
|
|
704
773
|
*/
|
|
705
774
|
ParallelDataProperties?: ParallelDataProperties;
|
|
706
775
|
/**
|
|
776
|
+
* @public
|
|
707
777
|
* <p>The Amazon S3 location of the most recent parallel data input file that was successfully
|
|
708
778
|
* imported into Amazon Translate. The location is returned as a presigned URL that has a
|
|
709
779
|
* 30-minute expiration.</p>
|
|
@@ -720,6 +790,7 @@ export interface GetParallelDataResponse {
|
|
|
720
790
|
*/
|
|
721
791
|
DataLocation?: ParallelDataDataLocation;
|
|
722
792
|
/**
|
|
793
|
+
* @public
|
|
723
794
|
* <p>The Amazon S3 location of a file that provides any errors or warnings that were produced
|
|
724
795
|
* by your input file. This file was created when Amazon Translate attempted to create a parallel
|
|
725
796
|
* data resource. The location is returned as a presigned URL to that has a 30-minute
|
|
@@ -727,6 +798,7 @@ export interface GetParallelDataResponse {
|
|
|
727
798
|
*/
|
|
728
799
|
AuxiliaryDataLocation?: ParallelDataDataLocation;
|
|
729
800
|
/**
|
|
801
|
+
* @public
|
|
730
802
|
* <p>The Amazon S3 location of a file that provides any errors or warnings that were produced
|
|
731
803
|
* by your input file. This file was created when Amazon Translate attempted to update a parallel
|
|
732
804
|
* data resource. The location is returned as a presigned URL to that has a 30-minute
|
|
@@ -752,10 +824,12 @@ export type TerminologyDataFormat = (typeof TerminologyDataFormat)[keyof typeof
|
|
|
752
824
|
*/
|
|
753
825
|
export interface GetTerminologyRequest {
|
|
754
826
|
/**
|
|
827
|
+
* @public
|
|
755
828
|
* <p>The name of the custom terminology being retrieved.</p>
|
|
756
829
|
*/
|
|
757
830
|
Name: string | undefined;
|
|
758
831
|
/**
|
|
832
|
+
* @public
|
|
759
833
|
* <p>The data format of the custom terminology being retrieved.</p>
|
|
760
834
|
* <p>If you don't specify this parameter, Amazon Translate returns a file with the same format
|
|
761
835
|
* as the file that was imported to create the terminology. </p>
|
|
@@ -771,10 +845,12 @@ export interface GetTerminologyRequest {
|
|
|
771
845
|
*/
|
|
772
846
|
export interface TerminologyDataLocation {
|
|
773
847
|
/**
|
|
848
|
+
* @public
|
|
774
849
|
* <p>The repository type for the custom terminology data.</p>
|
|
775
850
|
*/
|
|
776
851
|
RepositoryType: string | undefined;
|
|
777
852
|
/**
|
|
853
|
+
* @public
|
|
778
854
|
* <p>The Amazon S3 location of the most recent custom terminology input file that was
|
|
779
855
|
* successfully imported into Amazon Translate. The location is returned as a presigned URL that
|
|
780
856
|
* has a 30-minute expiration .</p>
|
|
@@ -809,48 +885,59 @@ export type Directionality = (typeof Directionality)[keyof typeof Directionality
|
|
|
809
885
|
*/
|
|
810
886
|
export interface TerminologyProperties {
|
|
811
887
|
/**
|
|
888
|
+
* @public
|
|
812
889
|
* <p>The name of the custom terminology.</p>
|
|
813
890
|
*/
|
|
814
891
|
Name?: string;
|
|
815
892
|
/**
|
|
893
|
+
* @public
|
|
816
894
|
* <p>The description of the custom terminology properties.</p>
|
|
817
895
|
*/
|
|
818
896
|
Description?: string;
|
|
819
897
|
/**
|
|
898
|
+
* @public
|
|
820
899
|
* <p> The Amazon Resource Name (ARN) of the custom terminology. </p>
|
|
821
900
|
*/
|
|
822
901
|
Arn?: string;
|
|
823
902
|
/**
|
|
903
|
+
* @public
|
|
824
904
|
* <p>The language code for the source text of the translation request for which the custom
|
|
825
905
|
* terminology is being used.</p>
|
|
826
906
|
*/
|
|
827
907
|
SourceLanguageCode?: string;
|
|
828
908
|
/**
|
|
909
|
+
* @public
|
|
829
910
|
* <p>The language codes for the target languages available with the custom terminology
|
|
830
911
|
* resource. All possible target languages are returned in array.</p>
|
|
831
912
|
*/
|
|
832
913
|
TargetLanguageCodes?: string[];
|
|
833
914
|
/**
|
|
915
|
+
* @public
|
|
834
916
|
* <p>The encryption key for the custom terminology.</p>
|
|
835
917
|
*/
|
|
836
918
|
EncryptionKey?: EncryptionKey;
|
|
837
919
|
/**
|
|
920
|
+
* @public
|
|
838
921
|
* <p>The size of the file used when importing a custom terminology.</p>
|
|
839
922
|
*/
|
|
840
923
|
SizeBytes?: number;
|
|
841
924
|
/**
|
|
925
|
+
* @public
|
|
842
926
|
* <p>The number of terms included in the custom terminology.</p>
|
|
843
927
|
*/
|
|
844
928
|
TermCount?: number;
|
|
845
929
|
/**
|
|
930
|
+
* @public
|
|
846
931
|
* <p>The time at which the custom terminology was created, based on the timestamp.</p>
|
|
847
932
|
*/
|
|
848
933
|
CreatedAt?: Date;
|
|
849
934
|
/**
|
|
935
|
+
* @public
|
|
850
936
|
* <p>The time at which the custom terminology was last update, based on the timestamp.</p>
|
|
851
937
|
*/
|
|
852
938
|
LastUpdatedAt?: Date;
|
|
853
939
|
/**
|
|
940
|
+
* @public
|
|
854
941
|
* <p>The directionality of your terminology resource indicates whether it has one source
|
|
855
942
|
* language (uni-directional) or multiple (multi-directional). </p>
|
|
856
943
|
* <dl>
|
|
@@ -867,15 +954,18 @@ export interface TerminologyProperties {
|
|
|
867
954
|
*/
|
|
868
955
|
Directionality?: Directionality | string;
|
|
869
956
|
/**
|
|
957
|
+
* @public
|
|
870
958
|
* <p>Additional information from Amazon Translate about the terminology resource.</p>
|
|
871
959
|
*/
|
|
872
960
|
Message?: string;
|
|
873
961
|
/**
|
|
962
|
+
* @public
|
|
874
963
|
* <p>The number of terms in the input file that Amazon Translate skipped when you created or
|
|
875
964
|
* updated the terminology resource.</p>
|
|
876
965
|
*/
|
|
877
966
|
SkippedTermCount?: number;
|
|
878
967
|
/**
|
|
968
|
+
* @public
|
|
879
969
|
* <p>The format of the custom terminology input file.</p>
|
|
880
970
|
*/
|
|
881
971
|
Format?: TerminologyDataFormat | string;
|
|
@@ -885,10 +975,12 @@ export interface TerminologyProperties {
|
|
|
885
975
|
*/
|
|
886
976
|
export interface GetTerminologyResponse {
|
|
887
977
|
/**
|
|
978
|
+
* @public
|
|
888
979
|
* <p>The properties of the custom terminology being retrieved.</p>
|
|
889
980
|
*/
|
|
890
981
|
TerminologyProperties?: TerminologyProperties;
|
|
891
982
|
/**
|
|
983
|
+
* @public
|
|
892
984
|
* <p>The Amazon S3 location of the most recent custom terminology input file that was
|
|
893
985
|
* successfully imported into Amazon Translate. The location is returned as a presigned URL that
|
|
894
986
|
* has a 30-minute expiration.</p>
|
|
@@ -905,6 +997,7 @@ export interface GetTerminologyResponse {
|
|
|
905
997
|
*/
|
|
906
998
|
TerminologyDataLocation?: TerminologyDataLocation;
|
|
907
999
|
/**
|
|
1000
|
+
* @public
|
|
908
1001
|
* <p>The Amazon S3 location of a file that provides any errors or warnings that were produced
|
|
909
1002
|
* by your input file. This file was created when Amazon Translate attempted to create a
|
|
910
1003
|
* terminology resource. The location is returned as a presigned URL to that has a 30-minute
|
|
@@ -931,16 +1024,19 @@ export type MergeStrategy = (typeof MergeStrategy)[keyof typeof MergeStrategy];
|
|
|
931
1024
|
*/
|
|
932
1025
|
export interface TerminologyData {
|
|
933
1026
|
/**
|
|
1027
|
+
* @public
|
|
934
1028
|
* <p>The file containing the custom terminology data. Your version of the AWS SDK performs a
|
|
935
1029
|
* Base64-encoding on this field before sending a request to the AWS service. Users of the SDK
|
|
936
1030
|
* should not perform Base64-encoding themselves.</p>
|
|
937
1031
|
*/
|
|
938
1032
|
File: Uint8Array | undefined;
|
|
939
1033
|
/**
|
|
1034
|
+
* @public
|
|
940
1035
|
* <p>The data format of the custom terminology.</p>
|
|
941
1036
|
*/
|
|
942
1037
|
Format: TerminologyDataFormat | string | undefined;
|
|
943
1038
|
/**
|
|
1039
|
+
* @public
|
|
944
1040
|
* <p>The directionality of your terminology resource indicates whether it has one source
|
|
945
1041
|
* language (uni-directional) or multiple (multi-directional).</p>
|
|
946
1042
|
* <dl>
|
|
@@ -968,28 +1064,34 @@ export interface TerminologyData {
|
|
|
968
1064
|
*/
|
|
969
1065
|
export interface ImportTerminologyRequest {
|
|
970
1066
|
/**
|
|
1067
|
+
* @public
|
|
971
1068
|
* <p>The name of the custom terminology being imported.</p>
|
|
972
1069
|
*/
|
|
973
1070
|
Name: string | undefined;
|
|
974
1071
|
/**
|
|
1072
|
+
* @public
|
|
975
1073
|
* <p>The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE
|
|
976
1074
|
* merge strategy is supported. In this case, the imported terminology will overwrite an existing
|
|
977
1075
|
* terminology of the same name.</p>
|
|
978
1076
|
*/
|
|
979
1077
|
MergeStrategy: MergeStrategy | string | undefined;
|
|
980
1078
|
/**
|
|
1079
|
+
* @public
|
|
981
1080
|
* <p>The description of the custom terminology being imported.</p>
|
|
982
1081
|
*/
|
|
983
1082
|
Description?: string;
|
|
984
1083
|
/**
|
|
1084
|
+
* @public
|
|
985
1085
|
* <p>The terminology data for the custom terminology being imported.</p>
|
|
986
1086
|
*/
|
|
987
1087
|
TerminologyData: TerminologyData | undefined;
|
|
988
1088
|
/**
|
|
1089
|
+
* @public
|
|
989
1090
|
* <p>The encryption key for the custom terminology being imported.</p>
|
|
990
1091
|
*/
|
|
991
1092
|
EncryptionKey?: EncryptionKey;
|
|
992
1093
|
/**
|
|
1094
|
+
* @public
|
|
993
1095
|
* <p>Tags to be associated with this resource. A tag is a key-value pair that
|
|
994
1096
|
* adds metadata to a resource. Each tag key for the resource must be unique.
|
|
995
1097
|
* For more information, see <a href="https://docs.aws.amazon.com/translate/latest/dg/tagging.html">
|
|
@@ -1002,10 +1104,12 @@ export interface ImportTerminologyRequest {
|
|
|
1002
1104
|
*/
|
|
1003
1105
|
export interface ImportTerminologyResponse {
|
|
1004
1106
|
/**
|
|
1107
|
+
* @public
|
|
1005
1108
|
* <p>The properties of the custom terminology being imported.</p>
|
|
1006
1109
|
*/
|
|
1007
1110
|
TerminologyProperties?: TerminologyProperties;
|
|
1008
1111
|
/**
|
|
1112
|
+
* @public
|
|
1009
1113
|
* <p>The Amazon S3 location of a file that provides any errors or warnings that were produced
|
|
1010
1114
|
* by your input file. This file was created when Amazon Translate attempted to create a
|
|
1011
1115
|
* terminology resource. The location is returned as a presigned URL to that has a 30 minute
|
|
@@ -1038,15 +1142,18 @@ export type DisplayLanguageCode = (typeof DisplayLanguageCode)[keyof typeof Disp
|
|
|
1038
1142
|
*/
|
|
1039
1143
|
export interface ListLanguagesRequest {
|
|
1040
1144
|
/**
|
|
1145
|
+
* @public
|
|
1041
1146
|
* <p>The language code for the language to use to display the language names in the response.
|
|
1042
1147
|
* The language code is <code>en</code> by default. </p>
|
|
1043
1148
|
*/
|
|
1044
1149
|
DisplayLanguageCode?: DisplayLanguageCode | string;
|
|
1045
1150
|
/**
|
|
1151
|
+
* @public
|
|
1046
1152
|
* <p>Include the NextToken value to fetch the next group of supported languages. </p>
|
|
1047
1153
|
*/
|
|
1048
1154
|
NextToken?: string;
|
|
1049
1155
|
/**
|
|
1156
|
+
* @public
|
|
1050
1157
|
* <p>The maximum number of results to return in each response.</p>
|
|
1051
1158
|
*/
|
|
1052
1159
|
MaxResults?: number;
|
|
@@ -1057,10 +1164,12 @@ export interface ListLanguagesRequest {
|
|
|
1057
1164
|
*/
|
|
1058
1165
|
export interface Language {
|
|
1059
1166
|
/**
|
|
1167
|
+
* @public
|
|
1060
1168
|
* <p>Language name of the supported language.</p>
|
|
1061
1169
|
*/
|
|
1062
1170
|
LanguageName: string | undefined;
|
|
1063
1171
|
/**
|
|
1172
|
+
* @public
|
|
1064
1173
|
* <p>Language code for the supported language.</p>
|
|
1065
1174
|
*/
|
|
1066
1175
|
LanguageCode: string | undefined;
|
|
@@ -1070,14 +1179,17 @@ export interface Language {
|
|
|
1070
1179
|
*/
|
|
1071
1180
|
export interface ListLanguagesResponse {
|
|
1072
1181
|
/**
|
|
1182
|
+
* @public
|
|
1073
1183
|
* <p>The list of supported languages.</p>
|
|
1074
1184
|
*/
|
|
1075
1185
|
Languages?: Language[];
|
|
1076
1186
|
/**
|
|
1187
|
+
* @public
|
|
1077
1188
|
* <p>The language code passed in with the request.</p>
|
|
1078
1189
|
*/
|
|
1079
1190
|
DisplayLanguageCode?: DisplayLanguageCode | string;
|
|
1080
1191
|
/**
|
|
1192
|
+
* @public
|
|
1081
1193
|
* <p> If the response does not include all remaining results, use the NextToken
|
|
1082
1194
|
* in the next request to fetch the next group of supported languages.</p>
|
|
1083
1195
|
*/
|
|
@@ -1092,6 +1204,7 @@ export declare class UnsupportedDisplayLanguageCodeException extends __BaseExcep
|
|
|
1092
1204
|
readonly $fault: "client";
|
|
1093
1205
|
Message?: string;
|
|
1094
1206
|
/**
|
|
1207
|
+
* @public
|
|
1095
1208
|
* <p>Language code passed in with the request.</p>
|
|
1096
1209
|
*/
|
|
1097
1210
|
DisplayLanguageCode?: string;
|
|
@@ -1105,10 +1218,12 @@ export declare class UnsupportedDisplayLanguageCodeException extends __BaseExcep
|
|
|
1105
1218
|
*/
|
|
1106
1219
|
export interface ListParallelDataRequest {
|
|
1107
1220
|
/**
|
|
1221
|
+
* @public
|
|
1108
1222
|
* <p>A string that specifies the next page of results to return in a paginated response.</p>
|
|
1109
1223
|
*/
|
|
1110
1224
|
NextToken?: string;
|
|
1111
1225
|
/**
|
|
1226
|
+
* @public
|
|
1112
1227
|
* <p>The maximum number of parallel data resources returned for each request.</p>
|
|
1113
1228
|
*/
|
|
1114
1229
|
MaxResults?: number;
|
|
@@ -1118,10 +1233,12 @@ export interface ListParallelDataRequest {
|
|
|
1118
1233
|
*/
|
|
1119
1234
|
export interface ListParallelDataResponse {
|
|
1120
1235
|
/**
|
|
1236
|
+
* @public
|
|
1121
1237
|
* <p>The properties of the parallel data resources returned by this request.</p>
|
|
1122
1238
|
*/
|
|
1123
1239
|
ParallelDataPropertiesList?: ParallelDataProperties[];
|
|
1124
1240
|
/**
|
|
1241
|
+
* @public
|
|
1125
1242
|
* <p>The string to use in a subsequent request to get the next page of results in a paginated
|
|
1126
1243
|
* response. This value is null if there are no additional pages.</p>
|
|
1127
1244
|
*/
|
|
@@ -1132,6 +1249,7 @@ export interface ListParallelDataResponse {
|
|
|
1132
1249
|
*/
|
|
1133
1250
|
export interface ListTagsForResourceRequest {
|
|
1134
1251
|
/**
|
|
1252
|
+
* @public
|
|
1135
1253
|
* <p>The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.
|
|
1136
1254
|
* </p>
|
|
1137
1255
|
*/
|
|
@@ -1142,6 +1260,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1142
1260
|
*/
|
|
1143
1261
|
export interface ListTagsForResourceResponse {
|
|
1144
1262
|
/**
|
|
1263
|
+
* @public
|
|
1145
1264
|
* <p>Tags associated with the Amazon Translate resource being queried. A tag is a key-value
|
|
1146
1265
|
* pair that adds as a metadata to a resource used by Amazon Translate. For example, a tag with
|
|
1147
1266
|
* "Sales" as the key might be added to a resource to indicate its use by the sales department.
|
|
@@ -1154,11 +1273,13 @@ export interface ListTagsForResourceResponse {
|
|
|
1154
1273
|
*/
|
|
1155
1274
|
export interface ListTerminologiesRequest {
|
|
1156
1275
|
/**
|
|
1276
|
+
* @public
|
|
1157
1277
|
* <p>If the result of the request to ListTerminologies was truncated, include the NextToken to
|
|
1158
1278
|
* fetch the next group of custom terminologies. </p>
|
|
1159
1279
|
*/
|
|
1160
1280
|
NextToken?: string;
|
|
1161
1281
|
/**
|
|
1282
|
+
* @public
|
|
1162
1283
|
* <p>The maximum number of custom terminologies returned per list request.</p>
|
|
1163
1284
|
*/
|
|
1164
1285
|
MaxResults?: number;
|
|
@@ -1168,10 +1289,12 @@ export interface ListTerminologiesRequest {
|
|
|
1168
1289
|
*/
|
|
1169
1290
|
export interface ListTerminologiesResponse {
|
|
1170
1291
|
/**
|
|
1292
|
+
* @public
|
|
1171
1293
|
* <p>The properties list of the custom terminologies returned on the list request.</p>
|
|
1172
1294
|
*/
|
|
1173
1295
|
TerminologyPropertiesList?: TerminologyProperties[];
|
|
1174
1296
|
/**
|
|
1297
|
+
* @public
|
|
1175
1298
|
* <p> If the response to the ListTerminologies was truncated, the NextToken fetches the next
|
|
1176
1299
|
* group of custom terminologies.</p>
|
|
1177
1300
|
*/
|
|
@@ -1197,20 +1320,24 @@ export declare class InvalidFilterException extends __BaseException {
|
|
|
1197
1320
|
*/
|
|
1198
1321
|
export interface TextTranslationJobFilter {
|
|
1199
1322
|
/**
|
|
1323
|
+
* @public
|
|
1200
1324
|
* <p>Filters the list of jobs by name.</p>
|
|
1201
1325
|
*/
|
|
1202
1326
|
JobName?: string;
|
|
1203
1327
|
/**
|
|
1328
|
+
* @public
|
|
1204
1329
|
* <p>Filters the list of jobs based by job status.</p>
|
|
1205
1330
|
*/
|
|
1206
1331
|
JobStatus?: JobStatus | string;
|
|
1207
1332
|
/**
|
|
1333
|
+
* @public
|
|
1208
1334
|
* <p>Filters the list of jobs based on the time that the job was submitted for processing and
|
|
1209
1335
|
* returns only the jobs submitted before the specified time. Jobs are returned in ascending
|
|
1210
1336
|
* order, oldest to newest.</p>
|
|
1211
1337
|
*/
|
|
1212
1338
|
SubmittedBeforeTime?: Date;
|
|
1213
1339
|
/**
|
|
1340
|
+
* @public
|
|
1214
1341
|
* <p>Filters the list of jobs based on the time that the job was submitted for processing and
|
|
1215
1342
|
* returns only the jobs submitted after the specified time. Jobs are returned in descending
|
|
1216
1343
|
* order, newest to oldest.</p>
|
|
@@ -1222,15 +1349,18 @@ export interface TextTranslationJobFilter {
|
|
|
1222
1349
|
*/
|
|
1223
1350
|
export interface ListTextTranslationJobsRequest {
|
|
1224
1351
|
/**
|
|
1352
|
+
* @public
|
|
1225
1353
|
* <p>The parameters that specify which batch translation jobs to retrieve. Filters include job
|
|
1226
1354
|
* name, job status, and submission time. You can only set one filter at a time.</p>
|
|
1227
1355
|
*/
|
|
1228
1356
|
Filter?: TextTranslationJobFilter;
|
|
1229
1357
|
/**
|
|
1358
|
+
* @public
|
|
1230
1359
|
* <p>The token to request the next page of results.</p>
|
|
1231
1360
|
*/
|
|
1232
1361
|
NextToken?: string;
|
|
1233
1362
|
/**
|
|
1363
|
+
* @public
|
|
1234
1364
|
* <p>The maximum number of results to return in each page. The default value is 100.</p>
|
|
1235
1365
|
*/
|
|
1236
1366
|
MaxResults?: number;
|
|
@@ -1240,10 +1370,12 @@ export interface ListTextTranslationJobsRequest {
|
|
|
1240
1370
|
*/
|
|
1241
1371
|
export interface ListTextTranslationJobsResponse {
|
|
1242
1372
|
/**
|
|
1373
|
+
* @public
|
|
1243
1374
|
* <p>A list containing the properties of each job that is returned.</p>
|
|
1244
1375
|
*/
|
|
1245
1376
|
TextTranslationJobPropertiesList?: TextTranslationJobProperties[];
|
|
1246
1377
|
/**
|
|
1378
|
+
* @public
|
|
1247
1379
|
* <p>The token to use to retrieve the next page of results. This value is <code>null</code>
|
|
1248
1380
|
* when there are no more results to return.</p>
|
|
1249
1381
|
*/
|
|
@@ -1254,25 +1386,30 @@ export interface ListTextTranslationJobsResponse {
|
|
|
1254
1386
|
*/
|
|
1255
1387
|
export interface StartTextTranslationJobRequest {
|
|
1256
1388
|
/**
|
|
1389
|
+
* @public
|
|
1257
1390
|
* <p>The name of the batch translation job to be performed.</p>
|
|
1258
1391
|
*/
|
|
1259
1392
|
JobName?: string;
|
|
1260
1393
|
/**
|
|
1394
|
+
* @public
|
|
1261
1395
|
* <p>Specifies the format and location of the input documents for the translation job.</p>
|
|
1262
1396
|
*/
|
|
1263
1397
|
InputDataConfig: InputDataConfig | undefined;
|
|
1264
1398
|
/**
|
|
1399
|
+
* @public
|
|
1265
1400
|
* <p>Specifies the S3 folder to which your job output will be saved.
|
|
1266
1401
|
* </p>
|
|
1267
1402
|
*/
|
|
1268
1403
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
1269
1404
|
/**
|
|
1405
|
+
* @public
|
|
1270
1406
|
* <p>The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role
|
|
1271
1407
|
* that grants Amazon Translate read access to your input data. For more information, see
|
|
1272
1408
|
* <a href="https://docs.aws.amazon.com/translate/latest/dg/identity-and-access-management.html">Identity and access management </a>.</p>
|
|
1273
1409
|
*/
|
|
1274
1410
|
DataAccessRoleArn: string | undefined;
|
|
1275
1411
|
/**
|
|
1412
|
+
* @public
|
|
1276
1413
|
* <p>The language code of the input language. Specify the language if all input documents share the same language.
|
|
1277
1414
|
* If you don't know the language of the source files, or your input documents contains different source
|
|
1278
1415
|
* languages, select <code>auto</code>. Amazon Translate auto detects the source language for each input document.
|
|
@@ -1281,12 +1418,14 @@ export interface StartTextTranslationJobRequest {
|
|
|
1281
1418
|
*/
|
|
1282
1419
|
SourceLanguageCode: string | undefined;
|
|
1283
1420
|
/**
|
|
1421
|
+
* @public
|
|
1284
1422
|
* <p>The target languages of the translation job. Enter up to 10 language codes.
|
|
1285
1423
|
* Each input file is translated into each target language.</p>
|
|
1286
1424
|
* <p>Each language code is 2 or 5 characters long. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
|
|
1287
1425
|
*/
|
|
1288
1426
|
TargetLanguageCodes: string[] | undefined;
|
|
1289
1427
|
/**
|
|
1428
|
+
* @public
|
|
1290
1429
|
* <p>The name of a custom terminology resource to add to the translation job. This resource
|
|
1291
1430
|
* lists examples source terms and the desired translation for each term.</p>
|
|
1292
1431
|
* <p>This parameter accepts only one custom terminology resource.</p>
|
|
@@ -1299,6 +1438,7 @@ export interface StartTextTranslationJobRequest {
|
|
|
1299
1438
|
*/
|
|
1300
1439
|
TerminologyNames?: string[];
|
|
1301
1440
|
/**
|
|
1441
|
+
* @public
|
|
1302
1442
|
* <p>The name of a parallel data resource to add to the translation job. This resource consists
|
|
1303
1443
|
* of examples that show how you want segments of text to be translated.
|
|
1304
1444
|
* If you specify multiple target languages for
|
|
@@ -1317,11 +1457,13 @@ export interface StartTextTranslationJobRequest {
|
|
|
1317
1457
|
*/
|
|
1318
1458
|
ParallelDataNames?: string[];
|
|
1319
1459
|
/**
|
|
1460
|
+
* @public
|
|
1320
1461
|
* <p>A unique identifier for the request. This token is generated for you when using the Amazon Translate
|
|
1321
1462
|
* SDK.</p>
|
|
1322
1463
|
*/
|
|
1323
1464
|
ClientToken?: string;
|
|
1324
1465
|
/**
|
|
1466
|
+
* @public
|
|
1325
1467
|
* <p>Settings to configure your translation output, including the option to set the formality
|
|
1326
1468
|
* level of the output text and the option to mask profane words and phrases.</p>
|
|
1327
1469
|
*/
|
|
@@ -1332,11 +1474,13 @@ export interface StartTextTranslationJobRequest {
|
|
|
1332
1474
|
*/
|
|
1333
1475
|
export interface StartTextTranslationJobResponse {
|
|
1334
1476
|
/**
|
|
1477
|
+
* @public
|
|
1335
1478
|
* <p>The identifier generated for the job. To get the status of a job, use this ID with the
|
|
1336
1479
|
* <a>DescribeTextTranslationJob</a> operation.</p>
|
|
1337
1480
|
*/
|
|
1338
1481
|
JobId?: string;
|
|
1339
1482
|
/**
|
|
1483
|
+
* @public
|
|
1340
1484
|
* <p>The status of the job. Possible values include:</p>
|
|
1341
1485
|
* <ul>
|
|
1342
1486
|
* <li>
|
|
@@ -1385,10 +1529,12 @@ export declare class UnsupportedLanguagePairException extends __BaseException {
|
|
|
1385
1529
|
readonly $fault: "client";
|
|
1386
1530
|
Message?: string;
|
|
1387
1531
|
/**
|
|
1532
|
+
* @public
|
|
1388
1533
|
* <p>The language code for the language of the input text. </p>
|
|
1389
1534
|
*/
|
|
1390
1535
|
SourceLanguageCode?: string;
|
|
1391
1536
|
/**
|
|
1537
|
+
* @public
|
|
1392
1538
|
* <p>The language code for the language of the translated text. </p>
|
|
1393
1539
|
*/
|
|
1394
1540
|
TargetLanguageCode?: string;
|
|
@@ -1402,6 +1548,7 @@ export declare class UnsupportedLanguagePairException extends __BaseException {
|
|
|
1402
1548
|
*/
|
|
1403
1549
|
export interface StopTextTranslationJobRequest {
|
|
1404
1550
|
/**
|
|
1551
|
+
* @public
|
|
1405
1552
|
* <p>The job ID of the job to be stopped.</p>
|
|
1406
1553
|
*/
|
|
1407
1554
|
JobId: string | undefined;
|
|
@@ -1411,10 +1558,12 @@ export interface StopTextTranslationJobRequest {
|
|
|
1411
1558
|
*/
|
|
1412
1559
|
export interface StopTextTranslationJobResponse {
|
|
1413
1560
|
/**
|
|
1561
|
+
* @public
|
|
1414
1562
|
* <p>The job ID of the stopped batch translation job.</p>
|
|
1415
1563
|
*/
|
|
1416
1564
|
JobId?: string;
|
|
1417
1565
|
/**
|
|
1566
|
+
* @public
|
|
1418
1567
|
* <p>The status of the designated job. Upon successful completion, the job's status will be
|
|
1419
1568
|
* <code>STOPPED</code>.</p>
|
|
1420
1569
|
*/
|
|
@@ -1425,11 +1574,13 @@ export interface StopTextTranslationJobResponse {
|
|
|
1425
1574
|
*/
|
|
1426
1575
|
export interface TagResourceRequest {
|
|
1427
1576
|
/**
|
|
1577
|
+
* @public
|
|
1428
1578
|
* <p>The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want
|
|
1429
1579
|
* to associate the tags. </p>
|
|
1430
1580
|
*/
|
|
1431
1581
|
ResourceArn: string | undefined;
|
|
1432
1582
|
/**
|
|
1583
|
+
* @public
|
|
1433
1584
|
* <p>Tags being associated with a specific Amazon Translate resource. There can be a maximum
|
|
1434
1585
|
* of 50 tags (both existing and pending) associated with a specific resource.</p>
|
|
1435
1586
|
*/
|
|
@@ -1460,6 +1611,7 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
1460
1611
|
*/
|
|
1461
1612
|
export interface Document {
|
|
1462
1613
|
/**
|
|
1614
|
+
* @public
|
|
1463
1615
|
* <p>The <code>Content</code>field type is Binary large object (blob).
|
|
1464
1616
|
* This object contains the document content converted into base64-encoded binary data.
|
|
1465
1617
|
* If you use one of the AWS SDKs, the SDK performs the
|
|
@@ -1468,6 +1620,7 @@ export interface Document {
|
|
|
1468
1620
|
*/
|
|
1469
1621
|
Content: Uint8Array | undefined;
|
|
1470
1622
|
/**
|
|
1623
|
+
* @public
|
|
1471
1624
|
* <p>Describes the format of the document. You can specify one of the following:</p>
|
|
1472
1625
|
* <ul>
|
|
1473
1626
|
* <li>
|
|
@@ -1494,10 +1647,12 @@ export interface Document {
|
|
|
1494
1647
|
*/
|
|
1495
1648
|
export interface TranslateDocumentRequest {
|
|
1496
1649
|
/**
|
|
1650
|
+
* @public
|
|
1497
1651
|
* <p>The content and content type for the document to be translated. The document size must not exceed 100 KB.</p>
|
|
1498
1652
|
*/
|
|
1499
1653
|
Document: Document | undefined;
|
|
1500
1654
|
/**
|
|
1655
|
+
* @public
|
|
1501
1656
|
* <p>The name of a terminology list file to add to the translation job. This file
|
|
1502
1657
|
* provides source terms and the desired translation for each term.
|
|
1503
1658
|
* A terminology list can contain a maximum of 256 terms.
|
|
@@ -1508,6 +1663,7 @@ export interface TranslateDocumentRequest {
|
|
|
1508
1663
|
*/
|
|
1509
1664
|
TerminologyNames?: string[];
|
|
1510
1665
|
/**
|
|
1666
|
+
* @public
|
|
1511
1667
|
* <p>The language code for the language of the source text. Do not use <code>auto</code>, because
|
|
1512
1668
|
* <code>TranslateDocument</code> does not support language auto-detection.
|
|
1513
1669
|
* For a list of supported language codes, see
|
|
@@ -1515,12 +1671,14 @@ export interface TranslateDocumentRequest {
|
|
|
1515
1671
|
*/
|
|
1516
1672
|
SourceLanguageCode: string | undefined;
|
|
1517
1673
|
/**
|
|
1674
|
+
* @public
|
|
1518
1675
|
* <p>The language code requested for the translated document.
|
|
1519
1676
|
* For a list of supported language codes, see
|
|
1520
1677
|
* <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
|
|
1521
1678
|
*/
|
|
1522
1679
|
TargetLanguageCode: string | undefined;
|
|
1523
1680
|
/**
|
|
1681
|
+
* @public
|
|
1524
1682
|
* <p>Settings to configure your translation output, including the option to set the formality
|
|
1525
1683
|
* level of the output text and the option to mask profane words and phrases.</p>
|
|
1526
1684
|
*/
|
|
@@ -1532,6 +1690,7 @@ export interface TranslateDocumentRequest {
|
|
|
1532
1690
|
*/
|
|
1533
1691
|
export interface TranslatedDocument {
|
|
1534
1692
|
/**
|
|
1693
|
+
* @public
|
|
1535
1694
|
* <p>The document containing the translated content.</p>
|
|
1536
1695
|
*/
|
|
1537
1696
|
Content: Uint8Array | undefined;
|
|
@@ -1541,23 +1700,28 @@ export interface TranslatedDocument {
|
|
|
1541
1700
|
*/
|
|
1542
1701
|
export interface TranslateDocumentResponse {
|
|
1543
1702
|
/**
|
|
1703
|
+
* @public
|
|
1544
1704
|
* <p>The document containing the translated content. The document format matches the source document format.</p>
|
|
1545
1705
|
*/
|
|
1546
1706
|
TranslatedDocument: TranslatedDocument | undefined;
|
|
1547
1707
|
/**
|
|
1708
|
+
* @public
|
|
1548
1709
|
* <p>The language code of the source document.</p>
|
|
1549
1710
|
*/
|
|
1550
1711
|
SourceLanguageCode: string | undefined;
|
|
1551
1712
|
/**
|
|
1713
|
+
* @public
|
|
1552
1714
|
* <p>The language code of the translated document. </p>
|
|
1553
1715
|
*/
|
|
1554
1716
|
TargetLanguageCode: string | undefined;
|
|
1555
1717
|
/**
|
|
1718
|
+
* @public
|
|
1556
1719
|
* <p>The names of the custom terminologies applied to the input text by Amazon Translate to produce the
|
|
1557
1720
|
* translated text document.</p>
|
|
1558
1721
|
*/
|
|
1559
1722
|
AppliedTerminologies?: AppliedTerminology[];
|
|
1560
1723
|
/**
|
|
1724
|
+
* @public
|
|
1561
1725
|
* <p>Settings to configure your translation output, including the option to set the formality
|
|
1562
1726
|
* level of the output text and the option to mask profane words and phrases.</p>
|
|
1563
1727
|
*/
|
|
@@ -1575,6 +1739,7 @@ export declare class DetectedLanguageLowConfidenceException extends __BaseExcept
|
|
|
1575
1739
|
readonly $fault: "client";
|
|
1576
1740
|
Message?: string;
|
|
1577
1741
|
/**
|
|
1742
|
+
* @public
|
|
1578
1743
|
* <p>The language code of the auto-detected language from Amazon Comprehend.</p>
|
|
1579
1744
|
*/
|
|
1580
1745
|
DetectedLanguageCode?: string;
|
|
@@ -1602,11 +1767,13 @@ export declare class TextSizeLimitExceededException extends __BaseException {
|
|
|
1602
1767
|
*/
|
|
1603
1768
|
export interface TranslateTextRequest {
|
|
1604
1769
|
/**
|
|
1770
|
+
* @public
|
|
1605
1771
|
* <p>The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on
|
|
1606
1772
|
* your character set, this may be fewer than 10,000 characters.</p>
|
|
1607
1773
|
*/
|
|
1608
1774
|
Text: string | undefined;
|
|
1609
1775
|
/**
|
|
1776
|
+
* @public
|
|
1610
1777
|
* <p>The name of a terminology list file to add to the translation job. This file
|
|
1611
1778
|
* provides source terms and the desired translation for each term.
|
|
1612
1779
|
* A terminology list can contain a maximum of 256 terms.
|
|
@@ -1617,6 +1784,7 @@ export interface TranslateTextRequest {
|
|
|
1617
1784
|
*/
|
|
1618
1785
|
TerminologyNames?: string[];
|
|
1619
1786
|
/**
|
|
1787
|
+
* @public
|
|
1620
1788
|
* <p>The language code for the language of the source text. For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
|
|
1621
1789
|
* <p>To have Amazon Translate determine the source language of your text, you can specify
|
|
1622
1790
|
* <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify
|
|
@@ -1629,11 +1797,13 @@ export interface TranslateTextRequest {
|
|
|
1629
1797
|
*/
|
|
1630
1798
|
SourceLanguageCode: string | undefined;
|
|
1631
1799
|
/**
|
|
1800
|
+
* @public
|
|
1632
1801
|
* <p>The language code requested for the language of the target text.
|
|
1633
1802
|
* For a list of language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
|
|
1634
1803
|
*/
|
|
1635
1804
|
TargetLanguageCode: string | undefined;
|
|
1636
1805
|
/**
|
|
1806
|
+
* @public
|
|
1637
1807
|
* <p>Settings to configure your translation output, including the option to set the formality
|
|
1638
1808
|
* level of the output text and the option to mask profane words and phrases.</p>
|
|
1639
1809
|
*/
|
|
@@ -1644,23 +1814,28 @@ export interface TranslateTextRequest {
|
|
|
1644
1814
|
*/
|
|
1645
1815
|
export interface TranslateTextResponse {
|
|
1646
1816
|
/**
|
|
1817
|
+
* @public
|
|
1647
1818
|
* <p>The translated text.</p>
|
|
1648
1819
|
*/
|
|
1649
1820
|
TranslatedText: string | undefined;
|
|
1650
1821
|
/**
|
|
1822
|
+
* @public
|
|
1651
1823
|
* <p>The language code for the language of the source text.</p>
|
|
1652
1824
|
*/
|
|
1653
1825
|
SourceLanguageCode: string | undefined;
|
|
1654
1826
|
/**
|
|
1827
|
+
* @public
|
|
1655
1828
|
* <p>The language code for the language of the target text. </p>
|
|
1656
1829
|
*/
|
|
1657
1830
|
TargetLanguageCode: string | undefined;
|
|
1658
1831
|
/**
|
|
1832
|
+
* @public
|
|
1659
1833
|
* <p>The names of the custom terminologies applied to the input text by Amazon Translate for the
|
|
1660
1834
|
* translated text response.</p>
|
|
1661
1835
|
*/
|
|
1662
1836
|
AppliedTerminologies?: AppliedTerminology[];
|
|
1663
1837
|
/**
|
|
1838
|
+
* @public
|
|
1664
1839
|
* <p>Optional settings that modify the translation output.</p>
|
|
1665
1840
|
*/
|
|
1666
1841
|
AppliedSettings?: TranslationSettings;
|
|
@@ -1670,11 +1845,13 @@ export interface TranslateTextResponse {
|
|
|
1670
1845
|
*/
|
|
1671
1846
|
export interface UntagResourceRequest {
|
|
1672
1847
|
/**
|
|
1848
|
+
* @public
|
|
1673
1849
|
* <p> The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you
|
|
1674
1850
|
* want to remove the tags. </p>
|
|
1675
1851
|
*/
|
|
1676
1852
|
ResourceArn: string | undefined;
|
|
1677
1853
|
/**
|
|
1854
|
+
* @public
|
|
1678
1855
|
* <p>The initial part of a key-value pair that forms a tag being removed from a given resource.
|
|
1679
1856
|
* Keys must be unique and cannot be duplicated for a particular resource.
|
|
1680
1857
|
* </p>
|
|
@@ -1691,18 +1868,22 @@ export interface UntagResourceResponse {
|
|
|
1691
1868
|
*/
|
|
1692
1869
|
export interface UpdateParallelDataRequest {
|
|
1693
1870
|
/**
|
|
1871
|
+
* @public
|
|
1694
1872
|
* <p>The name of the parallel data resource being updated.</p>
|
|
1695
1873
|
*/
|
|
1696
1874
|
Name: string | undefined;
|
|
1697
1875
|
/**
|
|
1876
|
+
* @public
|
|
1698
1877
|
* <p>A custom description for the parallel data resource in Amazon Translate.</p>
|
|
1699
1878
|
*/
|
|
1700
1879
|
Description?: string;
|
|
1701
1880
|
/**
|
|
1881
|
+
* @public
|
|
1702
1882
|
* <p>Specifies the format and S3 location of the parallel data input file.</p>
|
|
1703
1883
|
*/
|
|
1704
1884
|
ParallelDataConfig: ParallelDataConfig | undefined;
|
|
1705
1885
|
/**
|
|
1886
|
+
* @public
|
|
1706
1887
|
* <p>A unique identifier for the request. This token is automatically generated when you use
|
|
1707
1888
|
* Amazon Translate through an AWS SDK.</p>
|
|
1708
1889
|
*/
|
|
@@ -1713,21 +1894,25 @@ export interface UpdateParallelDataRequest {
|
|
|
1713
1894
|
*/
|
|
1714
1895
|
export interface UpdateParallelDataResponse {
|
|
1715
1896
|
/**
|
|
1897
|
+
* @public
|
|
1716
1898
|
* <p>The name of the parallel data resource being updated.</p>
|
|
1717
1899
|
*/
|
|
1718
1900
|
Name?: string;
|
|
1719
1901
|
/**
|
|
1902
|
+
* @public
|
|
1720
1903
|
* <p>The status of the parallel data resource that you are attempting to update. Your update
|
|
1721
1904
|
* request is accepted only if this status is either <code>ACTIVE</code> or
|
|
1722
1905
|
* <code>FAILED</code>.</p>
|
|
1723
1906
|
*/
|
|
1724
1907
|
Status?: ParallelDataStatus | string;
|
|
1725
1908
|
/**
|
|
1909
|
+
* @public
|
|
1726
1910
|
* <p>The status of the parallel data update attempt. When the updated parallel data resource is
|
|
1727
1911
|
* ready for you to use, the status is <code>ACTIVE</code>.</p>
|
|
1728
1912
|
*/
|
|
1729
1913
|
LatestUpdateAttemptStatus?: ParallelDataStatus | string;
|
|
1730
1914
|
/**
|
|
1915
|
+
* @public
|
|
1731
1916
|
* <p>The time that the most recent update was attempted.</p>
|
|
1732
1917
|
*/
|
|
1733
1918
|
LatestUpdateAttemptAt?: Date;
|
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.
|
|
4
|
+
"version": "3.385.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,15 +21,15 @@
|
|
|
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.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.385.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.385.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
29
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|