@aws-sdk/client-comprehend 3.47.2 → 3.51.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 (37) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/dist-cjs/Comprehend.js +60 -0
  3. package/dist-cjs/commands/DeleteResourcePolicyCommand.js +36 -0
  4. package/dist-cjs/commands/DescribeResourcePolicyCommand.js +36 -0
  5. package/dist-cjs/commands/ImportModelCommand.js +36 -0
  6. package/dist-cjs/commands/PutResourcePolicyCommand.js +36 -0
  7. package/dist-cjs/commands/index.js +4 -0
  8. package/dist-cjs/models/models_0.js +52 -4
  9. package/dist-cjs/protocols/Aws_json1_1.js +405 -3
  10. package/dist-es/Comprehend.js +60 -0
  11. package/dist-es/commands/DeleteResourcePolicyCommand.js +39 -0
  12. package/dist-es/commands/DescribeResourcePolicyCommand.js +39 -0
  13. package/dist-es/commands/ImportModelCommand.js +39 -0
  14. package/dist-es/commands/PutResourcePolicyCommand.js +39 -0
  15. package/dist-es/commands/index.js +4 -0
  16. package/dist-es/models/models_0.js +32 -0
  17. package/dist-es/protocols/Aws_json1_1.js +428 -4
  18. package/dist-types/Comprehend.d.ts +37 -2
  19. package/dist-types/ComprehendClient.d.ts +6 -2
  20. package/dist-types/commands/CreateEndpointCommand.d.ts +1 -2
  21. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +35 -0
  22. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +36 -0
  23. package/dist-types/commands/ImportModelCommand.d.ts +40 -0
  24. package/dist-types/commands/PutResourcePolicyCommand.d.ts +37 -0
  25. package/dist-types/commands/index.d.ts +4 -0
  26. package/dist-types/models/models_0.d.ts +279 -43
  27. package/dist-types/protocols/Aws_json1_1.d.ts +12 -0
  28. package/dist-types/ts3.4/Comprehend.d.ts +20 -0
  29. package/dist-types/ts3.4/ComprehendClient.d.ts +6 -2
  30. package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +17 -0
  31. package/dist-types/ts3.4/commands/DescribeResourcePolicyCommand.d.ts +17 -0
  32. package/dist-types/ts3.4/commands/ImportModelCommand.d.ts +17 -0
  33. package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +17 -0
  34. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  35. package/dist-types/ts3.4/models/models_0.d.ts +92 -0
  36. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +12 -0
  37. package/package.json +39 -33
@@ -17,8 +17,11 @@ export interface AugmentedManifestsListItem {
17
17
  */
18
18
  S3Uri: string | undefined;
19
19
  /**
20
- * <p>The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.</p>
21
- * <p>TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.</p>
20
+ * <p>The purpose of the data you've provided in the augmented manifest. You can either train or
21
+ * test this data. If you don't specify, the default is train.</p>
22
+ * <p>TRAIN - all of the documents in the manifest will be used for training. If no test
23
+ * documents are provided, Amazon Comprehend will automatically reserve a portion of the training
24
+ * documents for testing.</p>
22
25
  * <p> TEST - all of the documents in the manifest will be used for testing.</p>
23
26
  */
24
27
  Split?: Split | string;
@@ -34,24 +37,29 @@ export interface AugmentedManifestsListItem {
34
37
  */
35
38
  AttributeNames: string[] | undefined;
36
39
  /**
37
- * <p>The S3 prefix to the annotation files that are referred in the augmented manifest file.</p>
40
+ * <p>The S3 prefix to the annotation files that are referred in the augmented manifest
41
+ * file.</p>
38
42
  */
39
43
  AnnotationDataS3Uri?: string;
40
44
  /**
41
- * <p>The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.</p>
45
+ * <p>The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest
46
+ * file.</p>
42
47
  */
43
48
  SourceDocumentsS3Uri?: string;
44
49
  /**
45
- * <p>The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument. </p>
50
+ * <p>The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't
51
+ * specify, the default is PlainTextDocument. </p>
46
52
  * <ul>
47
53
  * <li>
48
54
  * <p>
49
- * <code>PLAIN_TEXT_DOCUMENT</code> A document type that represents any unicode text that is encoded in UTF-8.</p>
55
+ * <code>PLAIN_TEXT_DOCUMENT</code> A document type that represents any unicode text that
56
+ * is encoded in UTF-8.</p>
50
57
  * </li>
51
58
  * <li>
52
59
  * <p>
53
- * <code>SEMI_STRUCTURED_DOCUMENT</code> A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported.
54
- * For inference, Amazon Comprehend support PDFs, DOCX and TXT.</p>
60
+ * <code>SEMI_STRUCTURED_DOCUMENT</code> A document type with positional and structural
61
+ * context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For
62
+ * inference, Amazon Comprehend support PDFs, DOCX and TXT.</p>
55
63
  * </li>
56
64
  * </ul>
57
65
  */
@@ -649,8 +657,8 @@ export declare namespace SyntaxToken {
649
657
  const filterSensitiveLog: (obj: SyntaxToken) => any;
650
658
  }
651
659
  /**
652
- * <p>The result of calling the operation. The operation
653
- * returns one object that is successfully processed by the operation.</p>
660
+ * <p>The result of calling the operation. The
661
+ * operation returns one object that is successfully processed by the operation.</p>
654
662
  */
655
663
  export interface BatchDetectSyntaxItemResult {
656
664
  /**
@@ -670,10 +678,10 @@ export declare namespace BatchDetectSyntaxItemResult {
670
678
  }
671
679
  export interface BatchDetectSyntaxResponse {
672
680
  /**
673
- * <p>A list of objects containing the results
674
- * of the operation. The results are sorted in ascending order by the <code>Index</code> field
675
- * and match the order of the documents in the input list. If all of the documents contain an
676
- * error, the <code>ResultList</code> is empty.</p>
681
+ * <p>A list of objects containing the
682
+ * results of the operation. The results are sorted in ascending order by the <code>Index</code>
683
+ * field and match the order of the documents in the input list. If all of the documents contain
684
+ * an error, the <code>ResultList</code> is empty.</p>
677
685
  */
678
686
  ResultList: BatchDetectSyntaxItemResult[] | undefined;
679
687
  /**
@@ -988,9 +996,9 @@ export interface DocumentClassifierInputDataConfig {
988
996
  */
989
997
  S3Uri?: string;
990
998
  /**
991
- * <p>The Amazon S3 URI for the input data.
992
- * The Amazon S3 bucket must be in the same AWS Region as the API endpoint that you are calling.
993
- * The URI can point to a single input file or it can provide the prefix for a collection of input files. </p>
999
+ * <p>The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region
1000
+ * as the API endpoint that you are calling. The URI can point to a single input file or it can
1001
+ * provide the prefix for a collection of input files. </p>
994
1002
  */
995
1003
  TestS3Uri?: string;
996
1004
  /**
@@ -1130,9 +1138,10 @@ export interface CreateDocumentClassifierRequest {
1130
1138
  */
1131
1139
  DocumentClassifierName: string | undefined;
1132
1140
  /**
1133
- * <p>The version name given to the newly created classifier.
1134
- * Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed.
1135
- * The version name must be unique among all models with the same classifier name in the account/AWS Region.</p>
1141
+ * <p>The version name given to the newly created classifier. Version names can have a maximum
1142
+ * of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The
1143
+ * version name must be unique among all models with the same classifier name in the account/AWS
1144
+ * Region.</p>
1136
1145
  */
1137
1146
  VersionName?: string;
1138
1147
  /**
@@ -1214,6 +1223,23 @@ export interface CreateDocumentClassifierRequest {
1214
1223
  * </ul>
1215
1224
  */
1216
1225
  ModelKmsKeyId?: string;
1226
+ /**
1227
+ * <p>The resource-based policy to attach to your custom document classifier model. You can use
1228
+ * this policy to allow another AWS account to import your custom model.</p>
1229
+ * <p>Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line
1230
+ * breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the
1231
+ * JSON body is also enclosed in double quotes, then you must escape the double quotes that are
1232
+ * inside the policy:</p>
1233
+ * <p>
1234
+ * <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code>
1235
+ * </p>
1236
+ * <p>To avoid escaping quotes, you can use single quotes to enclose the policy and double
1237
+ * quotes to enclose the JSON names and values:</p>
1238
+ * <p>
1239
+ * <code>'{"attribute": "value", "attribute": ["value"]}'</code>
1240
+ * </p>
1241
+ */
1242
+ ModelPolicy?: string;
1217
1243
  }
1218
1244
  export declare namespace CreateDocumentClassifierRequest {
1219
1245
  /**
@@ -1350,8 +1376,9 @@ export interface EntityRecognizerAnnotations {
1350
1376
  */
1351
1377
  S3Uri: string | undefined;
1352
1378
  /**
1353
- * <p>This specifies the Amazon S3 location where the test annotations for an entity recognizer are located.
1354
- * The URI must be in the same AWS Region as the API endpoint that you are calling.</p>
1379
+ * <p>This specifies the Amazon S3 location where the test annotations for an entity recognizer
1380
+ * are located. The URI must be in the same AWS Region as the API endpoint that you are
1381
+ * calling.</p>
1355
1382
  */
1356
1383
  TestS3Uri?: string;
1357
1384
  }
@@ -1380,16 +1407,17 @@ export interface EntityRecognizerDocuments {
1380
1407
  */
1381
1408
  S3Uri: string | undefined;
1382
1409
  /**
1383
- * <p> Specifies the Amazon S3 location where the test documents for an entity recognizer are located.
1384
- * The URI must be in the same AWS Region as the API endpoint that you are calling.</p>
1410
+ * <p> Specifies the Amazon S3 location where the test documents for an entity recognizer are
1411
+ * located. The URI must be in the same AWS Region as the API endpoint that you are
1412
+ * calling.</p>
1385
1413
  */
1386
1414
  TestS3Uri?: string;
1387
1415
  /**
1388
- * <p> Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE.
1389
- *
1390
- * ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.
1391
- *
1392
- * ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.</p>
1416
+ * <p> Specifies how the text in an input file should be processed. This is optional, and the
1417
+ * default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document.
1418
+ * Use this option when you are processing large documents, such as newspaper articles or
1419
+ * scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document.
1420
+ * Use this option when you are processing many short documents, such as text messages.</p>
1393
1421
  */
1394
1422
  InputFormat?: InputFormat | string;
1395
1423
  }
@@ -1514,9 +1542,10 @@ export interface CreateEntityRecognizerRequest {
1514
1542
  */
1515
1543
  RecognizerName: string | undefined;
1516
1544
  /**
1517
- * <p>The version name given to the newly created recognizer.
1518
- * Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed.
1519
- * The version name must be unique among all models with the same recognizer name in the account/ AWS Region.</p>
1545
+ * <p>The version name given to the newly created recognizer. Version names can be a maximum of
1546
+ * 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The
1547
+ * version name must be unique among all models with the same recognizer name in the account/ AWS
1548
+ * Region.</p>
1520
1549
  */
1521
1550
  VersionName?: string;
1522
1551
  /**
@@ -1587,6 +1616,23 @@ export interface CreateEntityRecognizerRequest {
1587
1616
  * </ul>
1588
1617
  */
1589
1618
  ModelKmsKeyId?: string;
1619
+ /**
1620
+ * <p>The JSON resource-based policy to attach to your custom entity recognizer model. You can
1621
+ * use this policy to allow another AWS account to import your custom model.</p>
1622
+ * <p>Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for
1623
+ * your policy, enclose the attribute names and values in double quotes. If the JSON body is also
1624
+ * enclosed in double quotes, then you must escape the double quotes that are inside the
1625
+ * policy:</p>
1626
+ * <p>
1627
+ * <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code>
1628
+ * </p>
1629
+ * <p>To avoid escaping quotes, you can use single quotes to enclose the policy and double
1630
+ * quotes to enclose the JSON names and values:</p>
1631
+ * <p>
1632
+ * <code>'{"attribute": "value", "attribute": ["value"]}'</code>
1633
+ * </p>
1634
+ */
1635
+ ModelPolicy?: string;
1590
1636
  }
1591
1637
  export declare namespace CreateEntityRecognizerRequest {
1592
1638
  /**
@@ -1666,6 +1712,30 @@ export declare namespace DeleteEntityRecognizerResponse {
1666
1712
  */
1667
1713
  const filterSensitiveLog: (obj: DeleteEntityRecognizerResponse) => any;
1668
1714
  }
1715
+ export interface DeleteResourcePolicyRequest {
1716
+ /**
1717
+ * <p>The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.</p>
1718
+ */
1719
+ ResourceArn: string | undefined;
1720
+ /**
1721
+ * <p>The revision ID of the policy to delete.</p>
1722
+ */
1723
+ PolicyRevisionId?: string;
1724
+ }
1725
+ export declare namespace DeleteResourcePolicyRequest {
1726
+ /**
1727
+ * @internal
1728
+ */
1729
+ const filterSensitiveLog: (obj: DeleteResourcePolicyRequest) => any;
1730
+ }
1731
+ export interface DeleteResourcePolicyResponse {
1732
+ }
1733
+ export declare namespace DeleteResourcePolicyResponse {
1734
+ /**
1735
+ * @internal
1736
+ */
1737
+ const filterSensitiveLog: (obj: DeleteResourcePolicyResponse) => any;
1738
+ }
1669
1739
  export interface DescribeDocumentClassificationJobRequest {
1670
1740
  /**
1671
1741
  * <p>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its
@@ -1700,11 +1770,13 @@ export interface DocumentReaderConfig {
1700
1770
  * <ul>
1701
1771
  * <li>
1702
1772
  * <p>
1703
- * <code>TEXTRACT_DETECT_DOCUMENT_TEXT</code> - The service calls DetectDocumentText for PDF documents per page.</p>
1773
+ * <code>TEXTRACT_DETECT_DOCUMENT_TEXT</code> - The service calls DetectDocumentText
1774
+ * for PDF documents per page.</p>
1704
1775
  * </li>
1705
1776
  * <li>
1706
1777
  * <p>
1707
- * <code>TEXTRACT_ANALYZE_DOCUMENT</code> - The service calls AnalyzeDocument for PDF documents per page.</p>
1778
+ * <code>TEXTRACT_ANALYZE_DOCUMENT</code> - The service calls AnalyzeDocument for PDF
1779
+ * documents per page.</p>
1708
1780
  * </li>
1709
1781
  * </ul>
1710
1782
  */
@@ -1714,12 +1786,13 @@ export interface DocumentReaderConfig {
1714
1786
  * <ul>
1715
1787
  * <li>
1716
1788
  * <p>
1717
- * <code>SERVICE_DEFAULT</code> - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs</p>
1789
+ * <code>SERVICE_DEFAULT</code> - use service defaults for Document reading. For
1790
+ * Digital PDF it would mean using an internal parser instead of Textract APIs</p>
1718
1791
  * </li>
1719
1792
  * <li>
1720
1793
  * <p>
1721
- * <code>FORCE_DOCUMENT_READ_ACTION</code> - Always use specified action for DocumentReadAction, including Digital PDF.
1722
- * </p>
1794
+ * <code>FORCE_DOCUMENT_READ_ACTION</code> - Always use specified action for
1795
+ * DocumentReadAction, including Digital PDF. </p>
1723
1796
  * </li>
1724
1797
  * </ul>
1725
1798
  */
@@ -1767,9 +1840,11 @@ export interface InputDataConfig {
1767
1840
  */
1768
1841
  InputFormat?: InputFormat | string;
1769
1842
  /**
1770
- * <p>The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob. </p>
1771
- * <p>Use DocumentReaderConfig to provide specifications about how you want your inference documents read.
1772
- * Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.</p>
1843
+ * <p>The document reader config field applies only for InputDataConfig of
1844
+ * StartEntitiesDetectionJob. </p>
1845
+ * <p>Use DocumentReaderConfig to provide specifications about how you want your inference
1846
+ * documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom
1847
+ * inference.</p>
1773
1848
  */
1774
1849
  DocumentReaderConfig?: DocumentReaderConfig;
1775
1850
  }
@@ -2080,6 +2155,11 @@ export interface DocumentClassifierProperties {
2080
2155
  * <p>The version name that you assigned to the document classifier.</p>
2081
2156
  */
2082
2157
  VersionName?: string;
2158
+ /**
2159
+ * <p>The Amazon Resource Name (ARN) of the source model. This model was imported from a
2160
+ * different AWS account to create the document classifier model in your AWS account.</p>
2161
+ */
2162
+ SourceModelArn?: string;
2083
2163
  }
2084
2164
  export declare namespace DocumentClassifierProperties {
2085
2165
  /**
@@ -2255,7 +2335,8 @@ export interface EndpointProperties {
2255
2335
  */
2256
2336
  ModelArn?: string;
2257
2337
  /**
2258
- * <p>ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress</p>
2338
+ * <p>ARN of the new model to use for updating an existing endpoint. This ARN is going to be
2339
+ * different from the model ARN when the update is in progress</p>
2259
2340
  */
2260
2341
  DesiredModelArn?: string;
2261
2342
  /**
@@ -2283,7 +2364,8 @@ export interface EndpointProperties {
2283
2364
  */
2284
2365
  DataAccessRoleArn?: string;
2285
2366
  /**
2286
- * <p>Data access role ARN to use in case the new model is encrypted with a customer KMS key.</p>
2367
+ * <p>Data access role ARN to use in case the new model is encrypted with a customer KMS
2368
+ * key.</p>
2287
2369
  */
2288
2370
  DesiredDataAccessRoleArn?: string;
2289
2371
  }
@@ -2643,6 +2725,11 @@ export interface EntityRecognizerProperties {
2643
2725
  * <p>The version name you assigned to the entity recognizer.</p>
2644
2726
  */
2645
2727
  VersionName?: string;
2728
+ /**
2729
+ * <p>The Amazon Resource Name (ARN) of the source model. This model was imported from a
2730
+ * different AWS account to create the entity recognizer model in your AWS account.</p>
2731
+ */
2732
+ SourceModelArn?: string;
2646
2733
  }
2647
2734
  export declare namespace EntityRecognizerProperties {
2648
2735
  /**
@@ -3032,6 +3119,43 @@ export declare namespace DescribePiiEntitiesDetectionJobResponse {
3032
3119
  */
3033
3120
  const filterSensitiveLog: (obj: DescribePiiEntitiesDetectionJobResponse) => any;
3034
3121
  }
3122
+ export interface DescribeResourcePolicyRequest {
3123
+ /**
3124
+ * <p>The Amazon Resource Name (ARN) of the policy to describe.</p>
3125
+ */
3126
+ ResourceArn: string | undefined;
3127
+ }
3128
+ export declare namespace DescribeResourcePolicyRequest {
3129
+ /**
3130
+ * @internal
3131
+ */
3132
+ const filterSensitiveLog: (obj: DescribeResourcePolicyRequest) => any;
3133
+ }
3134
+ export interface DescribeResourcePolicyResponse {
3135
+ /**
3136
+ * <p>The JSON body of the resource-based policy.</p>
3137
+ */
3138
+ ResourcePolicy?: string;
3139
+ /**
3140
+ * <p>The time at which the policy was created.</p>
3141
+ */
3142
+ CreationTime?: Date;
3143
+ /**
3144
+ * <p>The time at which the policy was last modified.</p>
3145
+ */
3146
+ LastModifiedTime?: Date;
3147
+ /**
3148
+ * <p>The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a
3149
+ * new revision ID, and it deletes the prior version of the policy.</p>
3150
+ */
3151
+ PolicyRevisionId?: string;
3152
+ }
3153
+ export declare namespace DescribeResourcePolicyResponse {
3154
+ /**
3155
+ * @internal
3156
+ */
3157
+ const filterSensitiveLog: (obj: DescribeResourcePolicyResponse) => any;
3158
+ }
3035
3159
  export interface DescribeSentimentDetectionJobRequest {
3036
3160
  /**
3037
3161
  * <p>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its
@@ -3506,6 +3630,71 @@ export declare namespace DetectSyntaxResponse {
3506
3630
  */
3507
3631
  const filterSensitiveLog: (obj: DetectSyntaxResponse) => any;
3508
3632
  }
3633
+ export interface ImportModelRequest {
3634
+ /**
3635
+ * <p>The Amazon Resource Name (ARN) of the custom model to import.</p>
3636
+ */
3637
+ SourceModelArn: string | undefined;
3638
+ /**
3639
+ * <p>The name to assign to the custom model that is created in Amazon Comprehend by this
3640
+ * import.</p>
3641
+ */
3642
+ ModelName?: string;
3643
+ /**
3644
+ * <p>The version name given to the custom model that is created by this import. Version names
3645
+ * can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_)
3646
+ * are allowed. The version name must be unique among all models with the same classifier name in
3647
+ * the account/AWS Region.</p>
3648
+ */
3649
+ VersionName?: string;
3650
+ /**
3651
+ * <p>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
3652
+ * trained custom models. The ModelKmsKeyId can be either of the following formats:</p>
3653
+ * <ul>
3654
+ * <li>
3655
+ * <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code>
3656
+ * </p>
3657
+ * </li>
3658
+ * <li>
3659
+ * <p>Amazon Resource Name (ARN) of a KMS Key:
3660
+ * <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
3661
+ * </p>
3662
+ * </li>
3663
+ * </ul>
3664
+ */
3665
+ ModelKmsKeyId?: string;
3666
+ /**
3667
+ * <p>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows
3668
+ * Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom
3669
+ * model.</p>
3670
+ */
3671
+ DataAccessRoleArn?: string;
3672
+ /**
3673
+ * <p>Tags to be associated with the custom model that is created by this import. A tag is a
3674
+ * key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a
3675
+ * tag with "Sales" as the key might be added to a resource to indicate its use by the sales
3676
+ * department.</p>
3677
+ */
3678
+ Tags?: Tag[];
3679
+ }
3680
+ export declare namespace ImportModelRequest {
3681
+ /**
3682
+ * @internal
3683
+ */
3684
+ const filterSensitiveLog: (obj: ImportModelRequest) => any;
3685
+ }
3686
+ export interface ImportModelResponse {
3687
+ /**
3688
+ * <p>The Amazon Resource Name (ARN) of the custom model being imported.</p>
3689
+ */
3690
+ ModelArn?: string;
3691
+ }
3692
+ export declare namespace ImportModelResponse {
3693
+ /**
3694
+ * @internal
3695
+ */
3696
+ const filterSensitiveLog: (obj: ImportModelResponse) => any;
3697
+ }
3509
3698
  /**
3510
3699
  * <p>The filter specified for the operation is invalid. Specify a different
3511
3700
  * filter.</p>
@@ -3719,7 +3908,8 @@ export declare namespace ListDocumentClassifierSummariesResponse {
3719
3908
  }
3720
3909
  /**
3721
3910
  * <p>Provides information for filtering a list of dominant language detection jobs. For more
3722
- * information, see the operation.</p>
3911
+ * information, see the
3912
+ * operation.</p>
3723
3913
  */
3724
3914
  export interface DominantLanguageDetectionJobFilter {
3725
3915
  /**
@@ -4440,6 +4630,52 @@ export declare namespace ListTopicsDetectionJobsResponse {
4440
4630
  */
4441
4631
  const filterSensitiveLog: (obj: ListTopicsDetectionJobsResponse) => any;
4442
4632
  }
4633
+ export interface PutResourcePolicyRequest {
4634
+ /**
4635
+ * <p>The Amazon Resource Name (ARN) of the custom model to attach the policy to.</p>
4636
+ */
4637
+ ResourceArn: string | undefined;
4638
+ /**
4639
+ * <p>The JSON resource-based policy to attach to your custom model. Provide your JSON as a
4640
+ * UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the
4641
+ * attribute names and values in double quotes. If the JSON body is also enclosed in double
4642
+ * quotes, then you must escape the double quotes that are inside the policy:</p>
4643
+ * <p>
4644
+ * <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code>
4645
+ * </p>
4646
+ * <p>To avoid escaping quotes, you can use single quotes to enclose the policy and double
4647
+ * quotes to enclose the JSON names and values:</p>
4648
+ * <p>
4649
+ * <code>'{"attribute": "value", "attribute": ["value"]}'</code>
4650
+ * </p>
4651
+ */
4652
+ ResourcePolicy: string | undefined;
4653
+ /**
4654
+ * <p>The revision ID that Amazon Comprehend assigned to the policy that you are updating. If
4655
+ * you are creating a new policy that has no prior version, don't use this parameter. Amazon
4656
+ * Comprehend creates the revision ID for you.</p>
4657
+ */
4658
+ PolicyRevisionId?: string;
4659
+ }
4660
+ export declare namespace PutResourcePolicyRequest {
4661
+ /**
4662
+ * @internal
4663
+ */
4664
+ const filterSensitiveLog: (obj: PutResourcePolicyRequest) => any;
4665
+ }
4666
+ export interface PutResourcePolicyResponse {
4667
+ /**
4668
+ * <p>The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a
4669
+ * new revision ID, and it deletes the prior version of the policy.</p>
4670
+ */
4671
+ PolicyRevisionId?: string;
4672
+ }
4673
+ export declare namespace PutResourcePolicyResponse {
4674
+ /**
4675
+ * @internal
4676
+ */
4677
+ const filterSensitiveLog: (obj: PutResourcePolicyResponse) => any;
4678
+ }
4443
4679
  export interface StartDocumentClassificationJobRequest {
4444
4680
  /**
4445
4681
  * <p>The identifier of the job.</p>
@@ -13,6 +13,7 @@ import { CreateEntityRecognizerCommandInput, CreateEntityRecognizerCommandOutput
13
13
  import { DeleteDocumentClassifierCommandInput, DeleteDocumentClassifierCommandOutput } from "../commands/DeleteDocumentClassifierCommand";
14
14
  import { DeleteEndpointCommandInput, DeleteEndpointCommandOutput } from "../commands/DeleteEndpointCommand";
15
15
  import { DeleteEntityRecognizerCommandInput, DeleteEntityRecognizerCommandOutput } from "../commands/DeleteEntityRecognizerCommand";
16
+ import { DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput } from "../commands/DeleteResourcePolicyCommand";
16
17
  import { DescribeDocumentClassificationJobCommandInput, DescribeDocumentClassificationJobCommandOutput } from "../commands/DescribeDocumentClassificationJobCommand";
17
18
  import { DescribeDocumentClassifierCommandInput, DescribeDocumentClassifierCommandOutput } from "../commands/DescribeDocumentClassifierCommand";
18
19
  import { DescribeDominantLanguageDetectionJobCommandInput, DescribeDominantLanguageDetectionJobCommandOutput } from "../commands/DescribeDominantLanguageDetectionJobCommand";
@@ -22,6 +23,7 @@ import { DescribeEntityRecognizerCommandInput, DescribeEntityRecognizerCommandOu
22
23
  import { DescribeEventsDetectionJobCommandInput, DescribeEventsDetectionJobCommandOutput } from "../commands/DescribeEventsDetectionJobCommand";
23
24
  import { DescribeKeyPhrasesDetectionJobCommandInput, DescribeKeyPhrasesDetectionJobCommandOutput } from "../commands/DescribeKeyPhrasesDetectionJobCommand";
24
25
  import { DescribePiiEntitiesDetectionJobCommandInput, DescribePiiEntitiesDetectionJobCommandOutput } from "../commands/DescribePiiEntitiesDetectionJobCommand";
26
+ import { DescribeResourcePolicyCommandInput, DescribeResourcePolicyCommandOutput } from "../commands/DescribeResourcePolicyCommand";
25
27
  import { DescribeSentimentDetectionJobCommandInput, DescribeSentimentDetectionJobCommandOutput } from "../commands/DescribeSentimentDetectionJobCommand";
26
28
  import { DescribeTopicsDetectionJobCommandInput, DescribeTopicsDetectionJobCommandOutput } from "../commands/DescribeTopicsDetectionJobCommand";
27
29
  import { DetectDominantLanguageCommandInput, DetectDominantLanguageCommandOutput } from "../commands/DetectDominantLanguageCommand";
@@ -30,6 +32,7 @@ import { DetectKeyPhrasesCommandInput, DetectKeyPhrasesCommandOutput } from "../
30
32
  import { DetectPiiEntitiesCommandInput, DetectPiiEntitiesCommandOutput } from "../commands/DetectPiiEntitiesCommand";
31
33
  import { DetectSentimentCommandInput, DetectSentimentCommandOutput } from "../commands/DetectSentimentCommand";
32
34
  import { DetectSyntaxCommandInput, DetectSyntaxCommandOutput } from "../commands/DetectSyntaxCommand";
35
+ import { ImportModelCommandInput, ImportModelCommandOutput } from "../commands/ImportModelCommand";
33
36
  import { ListDocumentClassificationJobsCommandInput, ListDocumentClassificationJobsCommandOutput } from "../commands/ListDocumentClassificationJobsCommand";
34
37
  import { ListDocumentClassifiersCommandInput, ListDocumentClassifiersCommandOutput } from "../commands/ListDocumentClassifiersCommand";
35
38
  import { ListDocumentClassifierSummariesCommandInput, ListDocumentClassifierSummariesCommandOutput } from "../commands/ListDocumentClassifierSummariesCommand";
@@ -44,6 +47,7 @@ import { ListPiiEntitiesDetectionJobsCommandInput, ListPiiEntitiesDetectionJobsC
44
47
  import { ListSentimentDetectionJobsCommandInput, ListSentimentDetectionJobsCommandOutput } from "../commands/ListSentimentDetectionJobsCommand";
45
48
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
46
49
  import { ListTopicsDetectionJobsCommandInput, ListTopicsDetectionJobsCommandOutput } from "../commands/ListTopicsDetectionJobsCommand";
50
+ import { PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput } from "../commands/PutResourcePolicyCommand";
47
51
  import { StartDocumentClassificationJobCommandInput, StartDocumentClassificationJobCommandOutput } from "../commands/StartDocumentClassificationJobCommand";
48
52
  import { StartDominantLanguageDetectionJobCommandInput, StartDominantLanguageDetectionJobCommandOutput } from "../commands/StartDominantLanguageDetectionJobCommand";
49
53
  import { StartEntitiesDetectionJobCommandInput, StartEntitiesDetectionJobCommandOutput } from "../commands/StartEntitiesDetectionJobCommand";
@@ -76,6 +80,7 @@ export declare const serializeAws_json1_1CreateEntityRecognizerCommand: (input:
76
80
  export declare const serializeAws_json1_1DeleteDocumentClassifierCommand: (input: DeleteDocumentClassifierCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
77
81
  export declare const serializeAws_json1_1DeleteEndpointCommand: (input: DeleteEndpointCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
78
82
  export declare const serializeAws_json1_1DeleteEntityRecognizerCommand: (input: DeleteEntityRecognizerCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
83
+ export declare const serializeAws_json1_1DeleteResourcePolicyCommand: (input: DeleteResourcePolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
79
84
  export declare const serializeAws_json1_1DescribeDocumentClassificationJobCommand: (input: DescribeDocumentClassificationJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
80
85
  export declare const serializeAws_json1_1DescribeDocumentClassifierCommand: (input: DescribeDocumentClassifierCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
81
86
  export declare const serializeAws_json1_1DescribeDominantLanguageDetectionJobCommand: (input: DescribeDominantLanguageDetectionJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
@@ -85,6 +90,7 @@ export declare const serializeAws_json1_1DescribeEntityRecognizerCommand: (input
85
90
  export declare const serializeAws_json1_1DescribeEventsDetectionJobCommand: (input: DescribeEventsDetectionJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
86
91
  export declare const serializeAws_json1_1DescribeKeyPhrasesDetectionJobCommand: (input: DescribeKeyPhrasesDetectionJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
87
92
  export declare const serializeAws_json1_1DescribePiiEntitiesDetectionJobCommand: (input: DescribePiiEntitiesDetectionJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
93
+ export declare const serializeAws_json1_1DescribeResourcePolicyCommand: (input: DescribeResourcePolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
88
94
  export declare const serializeAws_json1_1DescribeSentimentDetectionJobCommand: (input: DescribeSentimentDetectionJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
89
95
  export declare const serializeAws_json1_1DescribeTopicsDetectionJobCommand: (input: DescribeTopicsDetectionJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
90
96
  export declare const serializeAws_json1_1DetectDominantLanguageCommand: (input: DetectDominantLanguageCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
@@ -93,6 +99,7 @@ export declare const serializeAws_json1_1DetectKeyPhrasesCommand: (input: Detect
93
99
  export declare const serializeAws_json1_1DetectPiiEntitiesCommand: (input: DetectPiiEntitiesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
94
100
  export declare const serializeAws_json1_1DetectSentimentCommand: (input: DetectSentimentCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
95
101
  export declare const serializeAws_json1_1DetectSyntaxCommand: (input: DetectSyntaxCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
102
+ export declare const serializeAws_json1_1ImportModelCommand: (input: ImportModelCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
96
103
  export declare const serializeAws_json1_1ListDocumentClassificationJobsCommand: (input: ListDocumentClassificationJobsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
97
104
  export declare const serializeAws_json1_1ListDocumentClassifiersCommand: (input: ListDocumentClassifiersCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
98
105
  export declare const serializeAws_json1_1ListDocumentClassifierSummariesCommand: (input: ListDocumentClassifierSummariesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
@@ -107,6 +114,7 @@ export declare const serializeAws_json1_1ListPiiEntitiesDetectionJobsCommand: (i
107
114
  export declare const serializeAws_json1_1ListSentimentDetectionJobsCommand: (input: ListSentimentDetectionJobsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
108
115
  export declare const serializeAws_json1_1ListTagsForResourceCommand: (input: ListTagsForResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
109
116
  export declare const serializeAws_json1_1ListTopicsDetectionJobsCommand: (input: ListTopicsDetectionJobsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
117
+ export declare const serializeAws_json1_1PutResourcePolicyCommand: (input: PutResourcePolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
110
118
  export declare const serializeAws_json1_1StartDocumentClassificationJobCommand: (input: StartDocumentClassificationJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
111
119
  export declare const serializeAws_json1_1StartDominantLanguageDetectionJobCommand: (input: StartDominantLanguageDetectionJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
112
120
  export declare const serializeAws_json1_1StartEntitiesDetectionJobCommand: (input: StartEntitiesDetectionJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
@@ -139,6 +147,7 @@ export declare const deserializeAws_json1_1CreateEntityRecognizerCommand: (outpu
139
147
  export declare const deserializeAws_json1_1DeleteDocumentClassifierCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteDocumentClassifierCommandOutput>;
140
148
  export declare const deserializeAws_json1_1DeleteEndpointCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteEndpointCommandOutput>;
141
149
  export declare const deserializeAws_json1_1DeleteEntityRecognizerCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteEntityRecognizerCommandOutput>;
150
+ export declare const deserializeAws_json1_1DeleteResourcePolicyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteResourcePolicyCommandOutput>;
142
151
  export declare const deserializeAws_json1_1DescribeDocumentClassificationJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeDocumentClassificationJobCommandOutput>;
143
152
  export declare const deserializeAws_json1_1DescribeDocumentClassifierCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeDocumentClassifierCommandOutput>;
144
153
  export declare const deserializeAws_json1_1DescribeDominantLanguageDetectionJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeDominantLanguageDetectionJobCommandOutput>;
@@ -148,6 +157,7 @@ export declare const deserializeAws_json1_1DescribeEntityRecognizerCommand: (out
148
157
  export declare const deserializeAws_json1_1DescribeEventsDetectionJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeEventsDetectionJobCommandOutput>;
149
158
  export declare const deserializeAws_json1_1DescribeKeyPhrasesDetectionJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeKeyPhrasesDetectionJobCommandOutput>;
150
159
  export declare const deserializeAws_json1_1DescribePiiEntitiesDetectionJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribePiiEntitiesDetectionJobCommandOutput>;
160
+ export declare const deserializeAws_json1_1DescribeResourcePolicyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeResourcePolicyCommandOutput>;
151
161
  export declare const deserializeAws_json1_1DescribeSentimentDetectionJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeSentimentDetectionJobCommandOutput>;
152
162
  export declare const deserializeAws_json1_1DescribeTopicsDetectionJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeTopicsDetectionJobCommandOutput>;
153
163
  export declare const deserializeAws_json1_1DetectDominantLanguageCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DetectDominantLanguageCommandOutput>;
@@ -156,6 +166,7 @@ export declare const deserializeAws_json1_1DetectKeyPhrasesCommand: (output: __H
156
166
  export declare const deserializeAws_json1_1DetectPiiEntitiesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DetectPiiEntitiesCommandOutput>;
157
167
  export declare const deserializeAws_json1_1DetectSentimentCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DetectSentimentCommandOutput>;
158
168
  export declare const deserializeAws_json1_1DetectSyntaxCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DetectSyntaxCommandOutput>;
169
+ export declare const deserializeAws_json1_1ImportModelCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ImportModelCommandOutput>;
159
170
  export declare const deserializeAws_json1_1ListDocumentClassificationJobsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListDocumentClassificationJobsCommandOutput>;
160
171
  export declare const deserializeAws_json1_1ListDocumentClassifiersCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListDocumentClassifiersCommandOutput>;
161
172
  export declare const deserializeAws_json1_1ListDocumentClassifierSummariesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListDocumentClassifierSummariesCommandOutput>;
@@ -170,6 +181,7 @@ export declare const deserializeAws_json1_1ListPiiEntitiesDetectionJobsCommand:
170
181
  export declare const deserializeAws_json1_1ListSentimentDetectionJobsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListSentimentDetectionJobsCommandOutput>;
171
182
  export declare const deserializeAws_json1_1ListTagsForResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListTagsForResourceCommandOutput>;
172
183
  export declare const deserializeAws_json1_1ListTopicsDetectionJobsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListTopicsDetectionJobsCommandOutput>;
184
+ export declare const deserializeAws_json1_1PutResourcePolicyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutResourcePolicyCommandOutput>;
173
185
  export declare const deserializeAws_json1_1StartDocumentClassificationJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StartDocumentClassificationJobCommandOutput>;
174
186
  export declare const deserializeAws_json1_1StartDominantLanguageDetectionJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StartDominantLanguageDetectionJobCommandOutput>;
175
187
  export declare const deserializeAws_json1_1StartEntitiesDetectionJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StartEntitiesDetectionJobCommandOutput>;