@aws-sdk/client-comprehend 3.298.0 → 3.299.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/README.md +1 -1
- package/dist-cjs/models/models_0.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +1 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +1 -0
- package/dist-types/Comprehend.d.ts +8 -8
- package/dist-types/ComprehendClient.d.ts +1 -1
- package/dist-types/commands/CreateFlywheelCommand.d.ts +1 -1
- package/dist-types/commands/ImportModelCommand.d.ts +4 -4
- package/dist-types/commands/ListDatasetsCommand.d.ts +1 -1
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +106 -108
- package/dist-types/models/models_1.d.ts +2 -2
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native.
|
|
11
11
|
|
|
12
|
-
<p>Amazon Comprehend is an
|
|
12
|
+
<p>Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents.
|
|
13
13
|
Use these actions to determine the topics contained in your documents, the topics they
|
|
14
14
|
discuss, the predominant sentiment expressed in them, the predominant language used, and
|
|
15
15
|
more.</p>
|
|
@@ -433,6 +433,7 @@ var ModelStatus;
|
|
|
433
433
|
ModelStatus["STOP_REQUESTED"] = "STOP_REQUESTED";
|
|
434
434
|
ModelStatus["SUBMITTED"] = "SUBMITTED";
|
|
435
435
|
ModelStatus["TRAINED"] = "TRAINED";
|
|
436
|
+
ModelStatus["TRAINED_WITH_WARNING"] = "TRAINED_WITH_WARNING";
|
|
436
437
|
ModelStatus["TRAINING"] = "TRAINING";
|
|
437
438
|
})(ModelStatus = exports.ModelStatus || (exports.ModelStatus = {}));
|
|
438
439
|
var EndpointStatus;
|
|
@@ -6541,6 +6541,7 @@ const deserializeAws_json1_1EntitiesDetectionJobProperties = (output, context) =
|
|
|
6541
6541
|
DataAccessRoleArn: (0, smithy_client_1.expectString)(output.DataAccessRoleArn),
|
|
6542
6542
|
EndTime: output.EndTime != null ? (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(output.EndTime))) : undefined,
|
|
6543
6543
|
EntityRecognizerArn: (0, smithy_client_1.expectString)(output.EntityRecognizerArn),
|
|
6544
|
+
FlywheelArn: (0, smithy_client_1.expectString)(output.FlywheelArn),
|
|
6544
6545
|
InputDataConfig: output.InputDataConfig != null
|
|
6545
6546
|
? deserializeAws_json1_1InputDataConfig(output.InputDataConfig, context)
|
|
6546
6547
|
: undefined,
|
|
@@ -416,6 +416,7 @@ export var ModelStatus;
|
|
|
416
416
|
ModelStatus["STOP_REQUESTED"] = "STOP_REQUESTED";
|
|
417
417
|
ModelStatus["SUBMITTED"] = "SUBMITTED";
|
|
418
418
|
ModelStatus["TRAINED"] = "TRAINED";
|
|
419
|
+
ModelStatus["TRAINED_WITH_WARNING"] = "TRAINED_WITH_WARNING";
|
|
419
420
|
ModelStatus["TRAINING"] = "TRAINING";
|
|
420
421
|
})(ModelStatus || (ModelStatus = {}));
|
|
421
422
|
export var EndpointStatus;
|
|
@@ -6367,6 +6367,7 @@ const deserializeAws_json1_1EntitiesDetectionJobProperties = (output, context) =
|
|
|
6367
6367
|
DataAccessRoleArn: __expectString(output.DataAccessRoleArn),
|
|
6368
6368
|
EndTime: output.EndTime != null ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.EndTime))) : undefined,
|
|
6369
6369
|
EntityRecognizerArn: __expectString(output.EntityRecognizerArn),
|
|
6370
|
+
FlywheelArn: __expectString(output.FlywheelArn),
|
|
6370
6371
|
InputDataConfig: output.InputDataConfig != null
|
|
6371
6372
|
? deserializeAws_json1_1InputDataConfig(output.InputDataConfig, context)
|
|
6372
6373
|
: undefined,
|
|
@@ -86,7 +86,7 @@ import { UpdateFlywheelCommandInput, UpdateFlywheelCommandOutput } from "./comma
|
|
|
86
86
|
import { ComprehendClient } from "./ComprehendClient";
|
|
87
87
|
/**
|
|
88
88
|
* @public
|
|
89
|
-
* <p>Amazon Comprehend is an
|
|
89
|
+
* <p>Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents.
|
|
90
90
|
* Use these actions to determine the topics contained in your documents, the topics they
|
|
91
91
|
* discuss, the predominant sentiment expressed in them, the predominant language used, and
|
|
92
92
|
* more.</p>
|
|
@@ -213,7 +213,7 @@ export declare class Comprehend extends ComprehendClient {
|
|
|
213
213
|
createEntityRecognizer(args: CreateEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEntityRecognizerCommandOutput) => void): void;
|
|
214
214
|
/**
|
|
215
215
|
* @public
|
|
216
|
-
* <p>A flywheel is an
|
|
216
|
+
* <p>A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification
|
|
217
217
|
* or custom entity recognition. You can create a flywheel to start with an existing trained model, or
|
|
218
218
|
* Comprehend can create and train a new model.</p>
|
|
219
219
|
* <p>When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training
|
|
@@ -483,18 +483,18 @@ export declare class Comprehend extends ComprehendClient {
|
|
|
483
483
|
/**
|
|
484
484
|
* @public
|
|
485
485
|
* <p>Creates a new custom model that replicates a source custom model that you import. The
|
|
486
|
-
* source model can be in your
|
|
487
|
-
* <p>If the source model is in another
|
|
486
|
+
* source model can be in your Amazon Web Services account or another one.</p>
|
|
487
|
+
* <p>If the source model is in another Amazon Web Services account, then it must have a resource-based policy
|
|
488
488
|
* that authorizes you to import it.</p>
|
|
489
|
-
* <p>The source model must be in the same
|
|
490
|
-
* can't import a model that's in a different
|
|
489
|
+
* <p>The source model must be in the same Amazon Web Services Region that you're using when you import. You
|
|
490
|
+
* can't import a model that's in a different Region.</p>
|
|
491
491
|
*/
|
|
492
492
|
importModel(args: ImportModelCommandInput, options?: __HttpHandlerOptions): Promise<ImportModelCommandOutput>;
|
|
493
493
|
importModel(args: ImportModelCommandInput, cb: (err: any, data?: ImportModelCommandOutput) => void): void;
|
|
494
494
|
importModel(args: ImportModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportModelCommandOutput) => void): void;
|
|
495
495
|
/**
|
|
496
496
|
* @public
|
|
497
|
-
* <p>List the datasets that you have configured in this
|
|
497
|
+
* <p>List the datasets that you have configured in this Region. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
498
498
|
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
499
499
|
*/
|
|
500
500
|
listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
|
|
@@ -630,7 +630,7 @@ export declare class Comprehend extends ComprehendClient {
|
|
|
630
630
|
/**
|
|
631
631
|
* @public
|
|
632
632
|
* <p>Attaches a resource-based policy to a custom model. You can use this policy to authorize
|
|
633
|
-
* an entity in another
|
|
633
|
+
* an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon
|
|
634
634
|
* Comprehend in their account.</p>
|
|
635
635
|
*/
|
|
636
636
|
putResourcePolicy(args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutResourcePolicyCommandOutput>;
|
|
@@ -227,7 +227,7 @@ export interface ComprehendClientResolvedConfig extends ComprehendClientResolved
|
|
|
227
227
|
}
|
|
228
228
|
/**
|
|
229
229
|
* @public
|
|
230
|
-
* <p>Amazon Comprehend is an
|
|
230
|
+
* <p>Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents.
|
|
231
231
|
* Use these actions to determine the topics contained in your documents, the topics they
|
|
232
232
|
* discuss, the predominant sentiment expressed in them, the predominant language used, and
|
|
233
233
|
* more.</p>
|
|
@@ -19,7 +19,7 @@ export interface CreateFlywheelCommandOutput extends CreateFlywheelResponse, __M
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>A flywheel is an
|
|
22
|
+
* <p>A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification
|
|
23
23
|
* or custom entity recognition. You can create a flywheel to start with an existing trained model, or
|
|
24
24
|
* Comprehend can create and train a new model.</p>
|
|
25
25
|
* <p>When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training
|
|
@@ -20,11 +20,11 @@ export interface ImportModelCommandOutput extends ImportModelResponse, __Metadat
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates a new custom model that replicates a source custom model that you import. The
|
|
23
|
-
* source model can be in your
|
|
24
|
-
* <p>If the source model is in another
|
|
23
|
+
* source model can be in your Amazon Web Services account or another one.</p>
|
|
24
|
+
* <p>If the source model is in another Amazon Web Services account, then it must have a resource-based policy
|
|
25
25
|
* that authorizes you to import it.</p>
|
|
26
|
-
* <p>The source model must be in the same
|
|
27
|
-
* can't import a model that's in a different
|
|
26
|
+
* <p>The source model must be in the same Amazon Web Services Region that you're using when you import. You
|
|
27
|
+
* can't import a model that's in a different Region.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -19,7 +19,7 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>List the datasets that you have configured in this
|
|
22
|
+
* <p>List the datasets that you have configured in this Region. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
23
23
|
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -20,7 +20,7 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Attaches a resource-based policy to a custom model. You can use this policy to authorize
|
|
23
|
-
* an entity in another
|
|
23
|
+
* an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon
|
|
24
24
|
* Comprehend in their account.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -529,10 +529,6 @@ export interface BatchDetectSentimentRequest {
|
|
|
529
529
|
/**
|
|
530
530
|
* <p>A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25
|
|
531
531
|
* documents. The maximum size of each document is 5 KB. </p>
|
|
532
|
-
* <note>
|
|
533
|
-
* <p>Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text
|
|
534
|
-
* and ignores any additional text in the input.</p>
|
|
535
|
-
* </note>
|
|
536
532
|
*/
|
|
537
533
|
TextList: string[] | undefined;
|
|
538
534
|
/**
|
|
@@ -1558,7 +1554,7 @@ export declare enum DatasetDataFormat {
|
|
|
1558
1554
|
*/
|
|
1559
1555
|
export interface DatasetDocumentClassifierInputDataConfig {
|
|
1560
1556
|
/**
|
|
1561
|
-
* <p>The Amazon S3 URI for the input data. The S3 bucket must be in the same
|
|
1557
|
+
* <p>The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API
|
|
1562
1558
|
* endpoint that you are calling. The URI can point to a single input file or it can provide the
|
|
1563
1559
|
* prefix for a collection of input files.</p>
|
|
1564
1560
|
* <p>For example, if you use the URI <code>S3://bucketName/prefix</code>, if the prefix is a
|
|
@@ -1585,7 +1581,7 @@ export interface DatasetDocumentClassifierInputDataConfig {
|
|
|
1585
1581
|
export interface DatasetEntityRecognizerAnnotations {
|
|
1586
1582
|
/**
|
|
1587
1583
|
* <p> Specifies the Amazon S3 location where the training documents for an entity recognizer
|
|
1588
|
-
* are located. The URI must be in the same
|
|
1584
|
+
* are located. The URI must be in the same Region as the API endpoint that you are
|
|
1589
1585
|
* calling.</p>
|
|
1590
1586
|
*/
|
|
1591
1587
|
S3Uri: string | undefined;
|
|
@@ -1852,7 +1848,7 @@ export interface DocumentClassifierInputDataConfig {
|
|
|
1852
1848
|
*/
|
|
1853
1849
|
DataFormat?: DocumentClassifierDataFormat | string;
|
|
1854
1850
|
/**
|
|
1855
|
-
* <p>The Amazon S3 URI for the input data. The S3 bucket must be in the same
|
|
1851
|
+
* <p>The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API
|
|
1856
1852
|
* endpoint that you are calling. The URI can point to a single input file or it can provide the
|
|
1857
1853
|
* prefix for a collection of input files.</p>
|
|
1858
1854
|
* <p>For example, if you use the URI <code>S3://bucketName/prefix</code>, if the prefix is a
|
|
@@ -1864,7 +1860,7 @@ export interface DocumentClassifierInputDataConfig {
|
|
|
1864
1860
|
S3Uri?: string;
|
|
1865
1861
|
/**
|
|
1866
1862
|
* <p>This specifies the Amazon S3 location where the test annotations for an entity recognizer
|
|
1867
|
-
* are located. The URI must be in the same
|
|
1863
|
+
* are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are
|
|
1868
1864
|
* calling. </p>
|
|
1869
1865
|
*/
|
|
1870
1866
|
TestS3Uri?: string;
|
|
@@ -1901,7 +1897,7 @@ export interface DocumentClassifierOutputDataConfig {
|
|
|
1901
1897
|
/**
|
|
1902
1898
|
* <p>When you use the <code>OutputDataConfig</code> object while creating a custom
|
|
1903
1899
|
* classifier, you specify the Amazon S3 location where you want to write the confusion matrix.
|
|
1904
|
-
* The URI must be in the same
|
|
1900
|
+
* The URI must be in the same Region as the API endpoint that you are calling. The location is
|
|
1905
1901
|
* used as the prefix for the actual location of this output file.</p>
|
|
1906
1902
|
* <p>When the custom classifier job is finished, the service creates the output file in a
|
|
1907
1903
|
* directory specific to the job. The <code>S3Uri</code> field contains the location of the
|
|
@@ -1910,7 +1906,7 @@ export interface DocumentClassifierOutputDataConfig {
|
|
|
1910
1906
|
*/
|
|
1911
1907
|
S3Uri?: string;
|
|
1912
1908
|
/**
|
|
1913
|
-
* <p>ID for the
|
|
1909
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the
|
|
1914
1910
|
* output results from an analysis job. The KmsKeyId can be one of the following formats:</p>
|
|
1915
1911
|
* <ul>
|
|
1916
1912
|
* <li>
|
|
@@ -1957,7 +1953,7 @@ export interface VpcConfig {
|
|
|
1957
1953
|
/**
|
|
1958
1954
|
* <p>The ID for each subnet being used in your private VPC. This subnet is a subset of the a
|
|
1959
1955
|
* range of IPv4 addresses used by the VPC and is specific to a given availability zone in the
|
|
1960
|
-
* VPC’s
|
|
1956
|
+
* VPC’s Region. This ID number is preceded by "subnet-", for instance:
|
|
1961
1957
|
* "subnet-04ccf456919e69055". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and
|
|
1962
1958
|
* Subnets</a>. </p>
|
|
1963
1959
|
*/
|
|
@@ -1974,12 +1970,11 @@ export interface CreateDocumentClassifierRequest {
|
|
|
1974
1970
|
/**
|
|
1975
1971
|
* <p>The version name given to the newly created classifier. Version names can have a maximum
|
|
1976
1972
|
* of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The
|
|
1977
|
-
* version name must be unique among all models with the same classifier name in the account/
|
|
1978
|
-
* Region.</p>
|
|
1973
|
+
* version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.</p>
|
|
1979
1974
|
*/
|
|
1980
1975
|
VersionName?: string;
|
|
1981
1976
|
/**
|
|
1982
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1977
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
1983
1978
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
1984
1979
|
*/
|
|
1985
1980
|
DataAccessRoleArn: string | undefined;
|
|
@@ -2010,7 +2005,7 @@ export interface CreateDocumentClassifierRequest {
|
|
|
2010
2005
|
*/
|
|
2011
2006
|
LanguageCode: LanguageCode | string | undefined;
|
|
2012
2007
|
/**
|
|
2013
|
-
* <p>ID for the
|
|
2008
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
2014
2009
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
2015
2010
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
2016
2011
|
* <ul>
|
|
@@ -2041,7 +2036,7 @@ export interface CreateDocumentClassifierRequest {
|
|
|
2041
2036
|
*/
|
|
2042
2037
|
Mode?: DocumentClassifierMode | string;
|
|
2043
2038
|
/**
|
|
2044
|
-
* <p>ID for the
|
|
2039
|
+
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt
|
|
2045
2040
|
* trained custom models. The ModelKmsKeyId can be either of the following formats:</p>
|
|
2046
2041
|
* <ul>
|
|
2047
2042
|
* <li>
|
|
@@ -2058,7 +2053,7 @@ export interface CreateDocumentClassifierRequest {
|
|
|
2058
2053
|
ModelKmsKeyId?: string;
|
|
2059
2054
|
/**
|
|
2060
2055
|
* <p>The resource-based policy to attach to your custom document classifier model. You can use
|
|
2061
|
-
* this policy to allow another
|
|
2056
|
+
* this policy to allow another Amazon Web Services account to import your custom model.</p>
|
|
2062
2057
|
* <p>Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line
|
|
2063
2058
|
* breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the
|
|
2064
2059
|
* JSON body is also enclosed in double quotes, then you must escape the double quotes that are
|
|
@@ -2130,7 +2125,7 @@ export interface CreateEndpointRequest {
|
|
|
2130
2125
|
*/
|
|
2131
2126
|
Tags?: Tag[];
|
|
2132
2127
|
/**
|
|
2133
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
2128
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
2134
2129
|
* grants Amazon Comprehend read access to trained custom models encrypted with a customer
|
|
2135
2130
|
* managed key (ModelKmsKeyId).</p>
|
|
2136
2131
|
*/
|
|
@@ -2162,12 +2157,12 @@ export interface CreateEndpointResponse {
|
|
|
2162
2157
|
export interface EntityRecognizerAnnotations {
|
|
2163
2158
|
/**
|
|
2164
2159
|
* <p> Specifies the Amazon S3 location where the annotations for an entity recognizer are
|
|
2165
|
-
* located. The URI must be in the same
|
|
2160
|
+
* located. The URI must be in the same Region as the API endpoint that you are calling.</p>
|
|
2166
2161
|
*/
|
|
2167
2162
|
S3Uri: string | undefined;
|
|
2168
2163
|
/**
|
|
2169
2164
|
* <p> Specifies the Amazon S3 location where the test annotations for an entity recognizer are
|
|
2170
|
-
* located. The URI must be in the same
|
|
2165
|
+
* located. The URI must be in the same Region as the API endpoint that you are calling.</p>
|
|
2171
2166
|
*/
|
|
2172
2167
|
TestS3Uri?: string;
|
|
2173
2168
|
}
|
|
@@ -2185,13 +2180,13 @@ export declare enum EntityRecognizerDataFormat {
|
|
|
2185
2180
|
export interface EntityRecognizerDocuments {
|
|
2186
2181
|
/**
|
|
2187
2182
|
* <p> Specifies the Amazon S3 location where the training documents for an entity recognizer
|
|
2188
|
-
* are located. The URI must be in the same
|
|
2183
|
+
* are located. The URI must be in the same Region as the API endpoint that you are
|
|
2189
2184
|
* calling.</p>
|
|
2190
2185
|
*/
|
|
2191
2186
|
S3Uri: string | undefined;
|
|
2192
2187
|
/**
|
|
2193
2188
|
* <p> Specifies the Amazon S3 location where the test documents for an entity recognizer are
|
|
2194
|
-
* located. The URI must be in the same
|
|
2189
|
+
* located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are
|
|
2195
2190
|
* calling.</p>
|
|
2196
2191
|
*/
|
|
2197
2192
|
TestS3Uri?: string;
|
|
@@ -2211,7 +2206,7 @@ export interface EntityRecognizerDocuments {
|
|
|
2211
2206
|
export interface EntityRecognizerEntityList {
|
|
2212
2207
|
/**
|
|
2213
2208
|
* <p>Specifies the Amazon S3 location where the entity list is located. The URI must be in the
|
|
2214
|
-
* same
|
|
2209
|
+
* same Region as the API endpoint that you are calling.</p>
|
|
2215
2210
|
*/
|
|
2216
2211
|
S3Uri: string | undefined;
|
|
2217
2212
|
}
|
|
@@ -2303,18 +2298,17 @@ export interface CreateEntityRecognizerRequest {
|
|
|
2303
2298
|
/**
|
|
2304
2299
|
* <p>The name given to the newly created recognizer. Recognizer names can be a maximum of 256
|
|
2305
2300
|
* characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name
|
|
2306
|
-
* must be unique in the account/
|
|
2301
|
+
* must be unique in the account/Region.</p>
|
|
2307
2302
|
*/
|
|
2308
2303
|
RecognizerName: string | undefined;
|
|
2309
2304
|
/**
|
|
2310
2305
|
* <p>The version name given to the newly created recognizer. Version names can be a maximum of
|
|
2311
2306
|
* 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The
|
|
2312
|
-
* version name must be unique among all models with the same recognizer name in the account/
|
|
2313
|
-
* Region.</p>
|
|
2307
|
+
* version name must be unique among all models with the same recognizer name in the account/Region.</p>
|
|
2314
2308
|
*/
|
|
2315
2309
|
VersionName?: string;
|
|
2316
2310
|
/**
|
|
2317
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
2311
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
2318
2312
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
2319
2313
|
*/
|
|
2320
2314
|
DataAccessRoleArn: string | undefined;
|
|
@@ -2327,7 +2321,7 @@ export interface CreateEntityRecognizerRequest {
|
|
|
2327
2321
|
Tags?: Tag[];
|
|
2328
2322
|
/**
|
|
2329
2323
|
* <p>Specifies the format and location of the input data. The S3 bucket containing the input
|
|
2330
|
-
* data must be located in the same
|
|
2324
|
+
* data must be located in the same Region as the entity recognizer being created. </p>
|
|
2331
2325
|
*/
|
|
2332
2326
|
InputDataConfig: EntityRecognizerInputDataConfig | undefined;
|
|
2333
2327
|
/**
|
|
@@ -2344,7 +2338,7 @@ export interface CreateEntityRecognizerRequest {
|
|
|
2344
2338
|
*/
|
|
2345
2339
|
LanguageCode: LanguageCode | string | undefined;
|
|
2346
2340
|
/**
|
|
2347
|
-
* <p>ID for the
|
|
2341
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
2348
2342
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
2349
2343
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
2350
2344
|
* <ul>
|
|
@@ -2368,7 +2362,7 @@ export interface CreateEntityRecognizerRequest {
|
|
|
2368
2362
|
*/
|
|
2369
2363
|
VpcConfig?: VpcConfig;
|
|
2370
2364
|
/**
|
|
2371
|
-
* <p>ID for the
|
|
2365
|
+
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt
|
|
2372
2366
|
* trained custom models. The ModelKmsKeyId can be either of the following formats:</p>
|
|
2373
2367
|
* <ul>
|
|
2374
2368
|
* <li>
|
|
@@ -2385,7 +2379,7 @@ export interface CreateEntityRecognizerRequest {
|
|
|
2385
2379
|
ModelKmsKeyId?: string;
|
|
2386
2380
|
/**
|
|
2387
2381
|
* <p>The JSON resource-based policy to attach to your custom entity recognizer model. You can
|
|
2388
|
-
* use this policy to allow another
|
|
2382
|
+
* use this policy to allow another Amazon Web Services account to import your custom model.</p>
|
|
2389
2383
|
* <p>Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for
|
|
2390
2384
|
* your policy, enclose the attribute names and values in double quotes. If the JSON body is also
|
|
2391
2385
|
* enclosed in double quotes, then you must escape the double quotes that are inside the
|
|
@@ -2416,7 +2410,7 @@ export interface CreateEntityRecognizerResponse {
|
|
|
2416
2410
|
*/
|
|
2417
2411
|
export interface DataSecurityConfig {
|
|
2418
2412
|
/**
|
|
2419
|
-
* <p>ID for the
|
|
2413
|
+
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt
|
|
2420
2414
|
* trained custom models. The ModelKmsKeyId can be either of the following formats:</p>
|
|
2421
2415
|
* <ul>
|
|
2422
2416
|
* <li>
|
|
@@ -2508,7 +2502,7 @@ export interface CreateFlywheelRequest {
|
|
|
2508
2502
|
*/
|
|
2509
2503
|
ActiveModelArn?: string;
|
|
2510
2504
|
/**
|
|
2511
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
2505
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
2512
2506
|
* grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.</p>
|
|
2513
2507
|
*/
|
|
2514
2508
|
DataAccessRoleArn: string | undefined;
|
|
@@ -2716,7 +2710,7 @@ export interface DescribeDocumentClassificationJobRequest {
|
|
|
2716
2710
|
*/
|
|
2717
2711
|
export interface InputDataConfig {
|
|
2718
2712
|
/**
|
|
2719
|
-
* <p>The Amazon S3 URI for the input data. The URI must be in same
|
|
2713
|
+
* <p>The Amazon S3 URI for the input data. The URI must be in same Region as the API
|
|
2720
2714
|
* endpoint that you are calling. The URI can point to a single input file or it can provide the
|
|
2721
2715
|
* prefix for a collection of data files. </p>
|
|
2722
2716
|
* <p>For example, if you use the URI <code>S3://bucketName/prefix</code>, if the prefix is a
|
|
@@ -2768,7 +2762,7 @@ export interface OutputDataConfig {
|
|
|
2768
2762
|
/**
|
|
2769
2763
|
* <p>When you use the <code>OutputDataConfig</code> object with asynchronous operations, you
|
|
2770
2764
|
* specify the Amazon S3 location where you want to write the output data. The URI must be in the
|
|
2771
|
-
* same
|
|
2765
|
+
* same Region as the API endpoint that you are calling. The location is used as the prefix for
|
|
2772
2766
|
* the actual location of the output file.</p>
|
|
2773
2767
|
* <p>When the topic detection job is finished, the service creates an output file in a
|
|
2774
2768
|
* directory specific to the job. The <code>S3Uri</code> field contains the location of the
|
|
@@ -2781,7 +2775,7 @@ export interface OutputDataConfig {
|
|
|
2781
2775
|
*/
|
|
2782
2776
|
S3Uri: string | undefined;
|
|
2783
2777
|
/**
|
|
2784
|
-
* <p>ID for the
|
|
2778
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the
|
|
2785
2779
|
* output results from an analysis job. The KmsKeyId can be one of the following formats:</p>
|
|
2786
2780
|
* <ul>
|
|
2787
2781
|
* <li>
|
|
@@ -2817,7 +2811,7 @@ export interface DocumentClassificationJobProperties {
|
|
|
2817
2811
|
JobId?: string;
|
|
2818
2812
|
/**
|
|
2819
2813
|
* <p>The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully
|
|
2820
|
-
* qualified identifier for the job. It includes the
|
|
2814
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
2821
2815
|
* format of the ARN is as follows:</p>
|
|
2822
2816
|
* <p>
|
|
2823
2817
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id></code>
|
|
@@ -2864,12 +2858,12 @@ export interface DocumentClassificationJobProperties {
|
|
|
2864
2858
|
*/
|
|
2865
2859
|
OutputDataConfig?: OutputDataConfig;
|
|
2866
2860
|
/**
|
|
2867
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
2861
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
2868
2862
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
2869
2863
|
*/
|
|
2870
2864
|
DataAccessRoleArn?: string;
|
|
2871
2865
|
/**
|
|
2872
|
-
* <p>ID for the
|
|
2866
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
2873
2867
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
2874
2868
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
2875
2869
|
* <ul>
|
|
@@ -2939,6 +2933,7 @@ export declare enum ModelStatus {
|
|
|
2939
2933
|
STOP_REQUESTED = "STOP_REQUESTED",
|
|
2940
2934
|
SUBMITTED = "SUBMITTED",
|
|
2941
2935
|
TRAINED = "TRAINED",
|
|
2936
|
+
TRAINED_WITH_WARNING = "TRAINED_WITH_WARNING",
|
|
2942
2937
|
TRAINING = "TRAINING"
|
|
2943
2938
|
}
|
|
2944
2939
|
/**
|
|
@@ -3000,12 +2995,12 @@ export interface DocumentClassifierProperties {
|
|
|
3000
2995
|
*/
|
|
3001
2996
|
ClassifierMetadata?: ClassifierMetadata;
|
|
3002
2997
|
/**
|
|
3003
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
2998
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
3004
2999
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
3005
3000
|
*/
|
|
3006
3001
|
DataAccessRoleArn?: string;
|
|
3007
3002
|
/**
|
|
3008
|
-
* <p>ID for the
|
|
3003
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
3009
3004
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
3010
3005
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
3011
3006
|
* <ul>
|
|
@@ -3034,7 +3029,7 @@ export interface DocumentClassifierProperties {
|
|
|
3034
3029
|
*/
|
|
3035
3030
|
Mode?: DocumentClassifierMode | string;
|
|
3036
3031
|
/**
|
|
3037
|
-
* <p>ID for the
|
|
3032
|
+
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt
|
|
3038
3033
|
* trained custom models. The ModelKmsKeyId can be either of the following formats:</p>
|
|
3039
3034
|
* <ul>
|
|
3040
3035
|
* <li>
|
|
@@ -3055,7 +3050,7 @@ export interface DocumentClassifierProperties {
|
|
|
3055
3050
|
VersionName?: string;
|
|
3056
3051
|
/**
|
|
3057
3052
|
* <p>The Amazon Resource Name (ARN) of the source model. This model was imported from a
|
|
3058
|
-
* different
|
|
3053
|
+
* different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.</p>
|
|
3059
3054
|
*/
|
|
3060
3055
|
SourceModelArn?: string;
|
|
3061
3056
|
/**
|
|
@@ -3093,7 +3088,7 @@ export interface DominantLanguageDetectionJobProperties {
|
|
|
3093
3088
|
JobId?: string;
|
|
3094
3089
|
/**
|
|
3095
3090
|
* <p>The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique,
|
|
3096
|
-
* fully qualified identifier for the job. It includes the
|
|
3091
|
+
* fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID.
|
|
3097
3092
|
* The format of the ARN is as follows:</p>
|
|
3098
3093
|
* <p>
|
|
3099
3094
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id></code>
|
|
@@ -3136,12 +3131,12 @@ export interface DominantLanguageDetectionJobProperties {
|
|
|
3136
3131
|
*/
|
|
3137
3132
|
OutputDataConfig?: OutputDataConfig;
|
|
3138
3133
|
/**
|
|
3139
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3134
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
3140
3135
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
3141
3136
|
*/
|
|
3142
3137
|
DataAccessRoleArn?: string;
|
|
3143
3138
|
/**
|
|
3144
|
-
* <p>ID for the
|
|
3139
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
3145
3140
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
3146
3141
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
3147
3142
|
* <ul>
|
|
@@ -3242,7 +3237,7 @@ export interface EndpointProperties {
|
|
|
3242
3237
|
*/
|
|
3243
3238
|
LastModifiedTime?: Date;
|
|
3244
3239
|
/**
|
|
3245
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3240
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
3246
3241
|
* grants Amazon Comprehend read access to trained custom models encrypted with a customer
|
|
3247
3242
|
* managed key (ModelKmsKeyId).</p>
|
|
3248
3243
|
*/
|
|
@@ -3287,7 +3282,7 @@ export interface EntitiesDetectionJobProperties {
|
|
|
3287
3282
|
JobId?: string;
|
|
3288
3283
|
/**
|
|
3289
3284
|
* <p>The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully
|
|
3290
|
-
* qualified identifier for the job. It includes the
|
|
3285
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
3291
3286
|
* format of the ARN is as follows:</p>
|
|
3292
3287
|
* <p>
|
|
3293
3288
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id></code>
|
|
@@ -3338,12 +3333,12 @@ export interface EntitiesDetectionJobProperties {
|
|
|
3338
3333
|
*/
|
|
3339
3334
|
LanguageCode?: LanguageCode | string;
|
|
3340
3335
|
/**
|
|
3341
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3336
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
3342
3337
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
3343
3338
|
*/
|
|
3344
3339
|
DataAccessRoleArn?: string;
|
|
3345
3340
|
/**
|
|
3346
|
-
* <p>ID for the
|
|
3341
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
3347
3342
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
3348
3343
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
3349
3344
|
* <ul>
|
|
@@ -3365,6 +3360,10 @@ export interface EntitiesDetectionJobProperties {
|
|
|
3365
3360
|
* VPC</a>. </p>
|
|
3366
3361
|
*/
|
|
3367
3362
|
VpcConfig?: VpcConfig;
|
|
3363
|
+
/**
|
|
3364
|
+
* <p>The Amazon Resource Name (ARN) of the flywheel associated with this job.</p>
|
|
3365
|
+
*/
|
|
3366
|
+
FlywheelArn?: string;
|
|
3368
3367
|
}
|
|
3369
3368
|
/**
|
|
3370
3369
|
* @public
|
|
@@ -3537,12 +3536,12 @@ export interface EntityRecognizerProperties {
|
|
|
3537
3536
|
*/
|
|
3538
3537
|
RecognizerMetadata?: EntityRecognizerMetadata;
|
|
3539
3538
|
/**
|
|
3540
|
-
* <p> The Amazon Resource Name (ARN) of the
|
|
3539
|
+
* <p> The Amazon Resource Name (ARN) of the IAM role that
|
|
3541
3540
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
3542
3541
|
*/
|
|
3543
3542
|
DataAccessRoleArn?: string;
|
|
3544
3543
|
/**
|
|
3545
|
-
* <p>ID for the
|
|
3544
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
3546
3545
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
3547
3546
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
3548
3547
|
* <ul>
|
|
@@ -3565,7 +3564,7 @@ export interface EntityRecognizerProperties {
|
|
|
3565
3564
|
*/
|
|
3566
3565
|
VpcConfig?: VpcConfig;
|
|
3567
3566
|
/**
|
|
3568
|
-
* <p>ID for the
|
|
3567
|
+
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt
|
|
3569
3568
|
* trained custom models. The ModelKmsKeyId can be either of the following formats:</p>
|
|
3570
3569
|
* <ul>
|
|
3571
3570
|
* <li>
|
|
@@ -3586,7 +3585,7 @@ export interface EntityRecognizerProperties {
|
|
|
3586
3585
|
VersionName?: string;
|
|
3587
3586
|
/**
|
|
3588
3587
|
* <p>The Amazon Resource Name (ARN) of the source model. This model was imported from a
|
|
3589
|
-
* different
|
|
3588
|
+
* different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.</p>
|
|
3590
3589
|
*/
|
|
3591
3590
|
SourceModelArn?: string;
|
|
3592
3591
|
/**
|
|
@@ -3627,7 +3626,7 @@ export interface EventsDetectionJobProperties {
|
|
|
3627
3626
|
JobId?: string;
|
|
3628
3627
|
/**
|
|
3629
3628
|
* <p>The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully
|
|
3630
|
-
* qualified identifier for the job. It includes the
|
|
3629
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
3631
3630
|
* format of the ARN is as follows:</p>
|
|
3632
3631
|
* <p>
|
|
3633
3632
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id></code>
|
|
@@ -3673,7 +3672,7 @@ export interface EventsDetectionJobProperties {
|
|
|
3673
3672
|
*/
|
|
3674
3673
|
LanguageCode?: LanguageCode | string;
|
|
3675
3674
|
/**
|
|
3676
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3675
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
3677
3676
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
3678
3677
|
*/
|
|
3679
3678
|
DataAccessRoleArn?: string;
|
|
@@ -3724,7 +3723,7 @@ export interface FlywheelProperties {
|
|
|
3724
3723
|
*/
|
|
3725
3724
|
ActiveModelArn?: string;
|
|
3726
3725
|
/**
|
|
3727
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3726
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
3728
3727
|
* grants Amazon Comprehend permission to access the flywheel data.</p>
|
|
3729
3728
|
*/
|
|
3730
3729
|
DataAccessRoleArn?: string;
|
|
@@ -3901,7 +3900,7 @@ export interface KeyPhrasesDetectionJobProperties {
|
|
|
3901
3900
|
JobId?: string;
|
|
3902
3901
|
/**
|
|
3903
3902
|
* <p>The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully
|
|
3904
|
-
* qualified identifier for the job. It includes the
|
|
3903
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
3905
3904
|
* format of the ARN is as follows:</p>
|
|
3906
3905
|
* <p>
|
|
3907
3906
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id></code>
|
|
@@ -3948,12 +3947,12 @@ export interface KeyPhrasesDetectionJobProperties {
|
|
|
3948
3947
|
*/
|
|
3949
3948
|
LanguageCode?: LanguageCode | string;
|
|
3950
3949
|
/**
|
|
3951
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3950
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
3952
3951
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
3953
3952
|
*/
|
|
3954
3953
|
DataAccessRoleArn?: string;
|
|
3955
3954
|
/**
|
|
3956
|
-
* <p>ID for the
|
|
3955
|
+
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt
|
|
3957
3956
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
3958
3957
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
3959
3958
|
* <ul>
|
|
@@ -4018,7 +4017,7 @@ export interface PiiOutputDataConfig {
|
|
|
4018
4017
|
*/
|
|
4019
4018
|
S3Uri: string | undefined;
|
|
4020
4019
|
/**
|
|
4021
|
-
* <p>ID for the
|
|
4020
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the
|
|
4022
4021
|
* output results from an analysis job.</p>
|
|
4023
4022
|
*/
|
|
4024
4023
|
KmsKeyId?: string;
|
|
@@ -4061,7 +4060,7 @@ export interface PiiEntitiesDetectionJobProperties {
|
|
|
4061
4060
|
JobId?: string;
|
|
4062
4061
|
/**
|
|
4063
4062
|
* <p>The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully
|
|
4064
|
-
* qualified identifier for the job. It includes the
|
|
4063
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
4065
4064
|
* format of the ARN is as follows:</p>
|
|
4066
4065
|
* <p>
|
|
4067
4066
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id></code>
|
|
@@ -4114,7 +4113,7 @@ export interface PiiEntitiesDetectionJobProperties {
|
|
|
4114
4113
|
*/
|
|
4115
4114
|
LanguageCode?: LanguageCode | string;
|
|
4116
4115
|
/**
|
|
4117
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4116
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
4118
4117
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
4119
4118
|
*/
|
|
4120
4119
|
DataAccessRoleArn?: string;
|
|
@@ -4185,7 +4184,7 @@ export interface SentimentDetectionJobProperties {
|
|
|
4185
4184
|
JobId?: string;
|
|
4186
4185
|
/**
|
|
4187
4186
|
* <p>The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully
|
|
4188
|
-
* qualified identifier for the job. It includes the
|
|
4187
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
4189
4188
|
* format of the ARN is as follows:</p>
|
|
4190
4189
|
* <p>
|
|
4191
4190
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id></code>
|
|
@@ -4232,12 +4231,12 @@ export interface SentimentDetectionJobProperties {
|
|
|
4232
4231
|
*/
|
|
4233
4232
|
LanguageCode?: LanguageCode | string;
|
|
4234
4233
|
/**
|
|
4235
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4234
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
4236
4235
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
4237
4236
|
*/
|
|
4238
4237
|
DataAccessRoleArn?: string;
|
|
4239
4238
|
/**
|
|
4240
|
-
* <p>ID for the
|
|
4239
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
4241
4240
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
4242
4241
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
4243
4242
|
* <ul>
|
|
@@ -4291,7 +4290,7 @@ export interface TargetedSentimentDetectionJobProperties {
|
|
|
4291
4290
|
JobId?: string;
|
|
4292
4291
|
/**
|
|
4293
4292
|
* <p>The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully
|
|
4294
|
-
* qualified identifier for the job. It includes the
|
|
4293
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
4295
4294
|
* format of the ARN is as follows:</p>
|
|
4296
4295
|
* <p>
|
|
4297
4296
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id></code>
|
|
@@ -4338,7 +4337,7 @@ export interface TargetedSentimentDetectionJobProperties {
|
|
|
4338
4337
|
*/
|
|
4339
4338
|
LanguageCode?: LanguageCode | string;
|
|
4340
4339
|
/**
|
|
4341
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4340
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
4342
4341
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
4343
4342
|
*/
|
|
4344
4343
|
DataAccessRoleArn?: string;
|
|
@@ -4395,7 +4394,7 @@ export interface TopicsDetectionJobProperties {
|
|
|
4395
4394
|
JobId?: string;
|
|
4396
4395
|
/**
|
|
4397
4396
|
* <p>The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully
|
|
4398
|
-
* qualified identifier for the job. It includes the
|
|
4397
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
4399
4398
|
* format of the ARN is as follows:</p>
|
|
4400
4399
|
* <p>
|
|
4401
4400
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id></code>
|
|
@@ -4443,12 +4442,12 @@ export interface TopicsDetectionJobProperties {
|
|
|
4443
4442
|
*/
|
|
4444
4443
|
NumberOfTopics?: number;
|
|
4445
4444
|
/**
|
|
4446
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4445
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
4447
4446
|
* grants Amazon Comprehend read access to your job data. </p>
|
|
4448
4447
|
*/
|
|
4449
4448
|
DataAccessRoleArn?: string;
|
|
4450
4449
|
/**
|
|
4451
|
-
* <p>ID for the
|
|
4450
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
4452
4451
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
4453
4452
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
4454
4453
|
* <ul>
|
|
@@ -4494,7 +4493,10 @@ export interface DetectDominantLanguageRequest {
|
|
|
4494
4493
|
*/
|
|
4495
4494
|
export interface DetectDominantLanguageResponse {
|
|
4496
4495
|
/**
|
|
4497
|
-
* <p>
|
|
4496
|
+
* <p>Array of languages that Amazon Comprehend detected in the input text.
|
|
4497
|
+
* The array is sorted in descending order of the score
|
|
4498
|
+
* (the dominant language is always the first element in the array).</p>
|
|
4499
|
+
* <p>For each language, the
|
|
4498
4500
|
* response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend
|
|
4499
4501
|
* has in the accuracy of its inference. For more information about RFC 5646, see <a href="https://tools.ietf.org/html/rfc5646">Tags for Identifying Languages</a> on the
|
|
4500
4502
|
* <i>IETF Tools</i> web site.</p>
|
|
@@ -4673,10 +4675,6 @@ export interface DetectPiiEntitiesResponse {
|
|
|
4673
4675
|
export interface DetectSentimentRequest {
|
|
4674
4676
|
/**
|
|
4675
4677
|
* <p>A UTF-8 text string. The maximum string size is 5 KB.</p>
|
|
4676
|
-
* <note>
|
|
4677
|
-
* <p>Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text
|
|
4678
|
-
* and ignores any additional text in the input.</p>
|
|
4679
|
-
* </note>
|
|
4680
4678
|
*/
|
|
4681
4679
|
Text: string | undefined;
|
|
4682
4680
|
/**
|
|
@@ -4767,11 +4765,11 @@ export interface ImportModelRequest {
|
|
|
4767
4765
|
* <p>The version name given to the custom model that is created by this import. Version names
|
|
4768
4766
|
* can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_)
|
|
4769
4767
|
* are allowed. The version name must be unique among all models with the same classifier name in
|
|
4770
|
-
* the account/
|
|
4768
|
+
* the account/Region.</p>
|
|
4771
4769
|
*/
|
|
4772
4770
|
VersionName?: string;
|
|
4773
4771
|
/**
|
|
4774
|
-
* <p>ID for the
|
|
4772
|
+
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt
|
|
4775
4773
|
* trained custom models. The ModelKmsKeyId can be either of the following formats:</p>
|
|
4776
4774
|
* <ul>
|
|
4777
4775
|
* <li>
|
|
@@ -4787,7 +4785,7 @@ export interface ImportModelRequest {
|
|
|
4787
4785
|
*/
|
|
4788
4786
|
ModelKmsKeyId?: string;
|
|
4789
4787
|
/**
|
|
4790
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4788
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
4791
4789
|
* grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom
|
|
4792
4790
|
* model.</p>
|
|
4793
4791
|
*/
|
|
@@ -5920,7 +5918,7 @@ export interface StartDocumentClassificationJobRequest {
|
|
|
5920
5918
|
*/
|
|
5921
5919
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
5922
5920
|
/**
|
|
5923
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
5921
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
5924
5922
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
5925
5923
|
*/
|
|
5926
5924
|
DataAccessRoleArn: string | undefined;
|
|
@@ -5930,7 +5928,7 @@ export interface StartDocumentClassificationJobRequest {
|
|
|
5930
5928
|
*/
|
|
5931
5929
|
ClientRequestToken?: string;
|
|
5932
5930
|
/**
|
|
5933
|
-
* <p>ID for the
|
|
5931
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
5934
5932
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
5935
5933
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
5936
5934
|
* <ul>
|
|
@@ -5975,7 +5973,7 @@ export interface StartDocumentClassificationJobResponse {
|
|
|
5975
5973
|
JobId?: string;
|
|
5976
5974
|
/**
|
|
5977
5975
|
* <p>The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully
|
|
5978
|
-
* qualified identifier for the job. It includes the
|
|
5976
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
5979
5977
|
* format of the ARN is as follows:</p>
|
|
5980
5978
|
* <p>
|
|
5981
5979
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id></code>
|
|
@@ -6030,8 +6028,8 @@ export interface StartDominantLanguageDetectionJobRequest {
|
|
|
6030
6028
|
*/
|
|
6031
6029
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
6032
6030
|
/**
|
|
6033
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
6034
|
-
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/
|
|
6031
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
6032
|
+
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based permissions</a>.</p>
|
|
6035
6033
|
*/
|
|
6036
6034
|
DataAccessRoleArn: string | undefined;
|
|
6037
6035
|
/**
|
|
@@ -6044,7 +6042,7 @@ export interface StartDominantLanguageDetectionJobRequest {
|
|
|
6044
6042
|
*/
|
|
6045
6043
|
ClientRequestToken?: string;
|
|
6046
6044
|
/**
|
|
6047
|
-
* <p>ID for the
|
|
6045
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
6048
6046
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
6049
6047
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
6050
6048
|
* <ul>
|
|
@@ -6084,7 +6082,7 @@ export interface StartDominantLanguageDetectionJobResponse {
|
|
|
6084
6082
|
JobId?: string;
|
|
6085
6083
|
/**
|
|
6086
6084
|
* <p>The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique,
|
|
6087
|
-
* fully qualified identifier for the job. It includes the
|
|
6085
|
+
* fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID.
|
|
6088
6086
|
* The format of the ARN is as follows:</p>
|
|
6089
6087
|
* <p>
|
|
6090
6088
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id></code>
|
|
@@ -6127,8 +6125,8 @@ export interface StartEntitiesDetectionJobRequest {
|
|
|
6127
6125
|
*/
|
|
6128
6126
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
6129
6127
|
/**
|
|
6130
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
6131
|
-
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/
|
|
6128
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
6129
|
+
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based permissions</a>.</p>
|
|
6132
6130
|
*/
|
|
6133
6131
|
DataAccessRoleArn: string | undefined;
|
|
6134
6132
|
/**
|
|
@@ -6154,7 +6152,7 @@ export interface StartEntitiesDetectionJobRequest {
|
|
|
6154
6152
|
*/
|
|
6155
6153
|
ClientRequestToken?: string;
|
|
6156
6154
|
/**
|
|
6157
|
-
* <p>ID for the
|
|
6155
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
6158
6156
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
6159
6157
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
6160
6158
|
* <ul>
|
|
@@ -6198,7 +6196,7 @@ export interface StartEntitiesDetectionJobResponse {
|
|
|
6198
6196
|
JobId?: string;
|
|
6199
6197
|
/**
|
|
6200
6198
|
* <p>The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully
|
|
6201
|
-
* qualified identifier for the job. It includes the
|
|
6199
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
6202
6200
|
* format of the ARN is as follows:</p>
|
|
6203
6201
|
* <p>
|
|
6204
6202
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id></code>
|
|
@@ -6252,7 +6250,7 @@ export interface StartEventsDetectionJobRequest {
|
|
|
6252
6250
|
*/
|
|
6253
6251
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
6254
6252
|
/**
|
|
6255
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
6253
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
6256
6254
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
6257
6255
|
*/
|
|
6258
6256
|
DataAccessRoleArn: string | undefined;
|
|
@@ -6291,7 +6289,7 @@ export interface StartEventsDetectionJobResponse {
|
|
|
6291
6289
|
JobId?: string;
|
|
6292
6290
|
/**
|
|
6293
6291
|
* <p>The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully
|
|
6294
|
-
* qualified identifier for the job. It includes the
|
|
6292
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
6295
6293
|
* format of the ARN is as follows:</p>
|
|
6296
6294
|
* <p>
|
|
6297
6295
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id></code>
|
|
@@ -6347,8 +6345,8 @@ export interface StartKeyPhrasesDetectionJobRequest {
|
|
|
6347
6345
|
*/
|
|
6348
6346
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
6349
6347
|
/**
|
|
6350
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
6351
|
-
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/
|
|
6348
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
6349
|
+
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based permissions</a>.</p>
|
|
6352
6350
|
*/
|
|
6353
6351
|
DataAccessRoleArn: string | undefined;
|
|
6354
6352
|
/**
|
|
@@ -6366,7 +6364,7 @@ export interface StartKeyPhrasesDetectionJobRequest {
|
|
|
6366
6364
|
*/
|
|
6367
6365
|
ClientRequestToken?: string;
|
|
6368
6366
|
/**
|
|
6369
|
-
* <p>ID for the
|
|
6367
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
6370
6368
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
6371
6369
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
6372
6370
|
* <ul>
|
|
@@ -6407,7 +6405,7 @@ export interface StartKeyPhrasesDetectionJobResponse {
|
|
|
6407
6405
|
JobId?: string;
|
|
6408
6406
|
/**
|
|
6409
6407
|
* <p>The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully
|
|
6410
|
-
* qualified identifier for the job. It includes the
|
|
6408
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
6411
6409
|
* format of the ARN is as follows:</p>
|
|
6412
6410
|
* <p>
|
|
6413
6411
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id></code>
|
|
@@ -6462,7 +6460,7 @@ export interface StartPiiEntitiesDetectionJobRequest {
|
|
|
6462
6460
|
*/
|
|
6463
6461
|
RedactionConfig?: RedactionConfig;
|
|
6464
6462
|
/**
|
|
6465
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
6463
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
6466
6464
|
* grants Amazon Comprehend read access to your input data.</p>
|
|
6467
6465
|
*/
|
|
6468
6466
|
DataAccessRoleArn: string | undefined;
|
|
@@ -6496,7 +6494,7 @@ export interface StartPiiEntitiesDetectionJobResponse {
|
|
|
6496
6494
|
JobId?: string;
|
|
6497
6495
|
/**
|
|
6498
6496
|
* <p>The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully
|
|
6499
|
-
* qualified identifier for the job. It includes the
|
|
6497
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
6500
6498
|
* format of the ARN is as follows:</p>
|
|
6501
6499
|
* <p>
|
|
6502
6500
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id></code>
|
|
@@ -6525,8 +6523,8 @@ export interface StartSentimentDetectionJobRequest {
|
|
|
6525
6523
|
*/
|
|
6526
6524
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
6527
6525
|
/**
|
|
6528
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
6529
|
-
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/
|
|
6526
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
6527
|
+
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based permissions</a>.</p>
|
|
6530
6528
|
*/
|
|
6531
6529
|
DataAccessRoleArn: string | undefined;
|
|
6532
6530
|
/**
|
|
@@ -6544,7 +6542,7 @@ export interface StartSentimentDetectionJobRequest {
|
|
|
6544
6542
|
*/
|
|
6545
6543
|
ClientRequestToken?: string;
|
|
6546
6544
|
/**
|
|
6547
|
-
* <p>ID for the
|
|
6545
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
6548
6546
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
6549
6547
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
6550
6548
|
* <ul>
|
|
@@ -6584,7 +6582,7 @@ export interface StartSentimentDetectionJobResponse {
|
|
|
6584
6582
|
JobId?: string;
|
|
6585
6583
|
/**
|
|
6586
6584
|
* <p>The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully
|
|
6587
|
-
* qualified identifier for the job. It includes the
|
|
6585
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
6588
6586
|
* format of the ARN is as follows:</p>
|
|
6589
6587
|
* <p>
|
|
6590
6588
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id></code>
|
|
@@ -6628,7 +6626,7 @@ export interface StartTargetedSentimentDetectionJobRequest {
|
|
|
6628
6626
|
*/
|
|
6629
6627
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
6630
6628
|
/**
|
|
6631
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
6629
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
6632
6630
|
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions">Role-based permissions</a>.</p>
|
|
6633
6631
|
*/
|
|
6634
6632
|
DataAccessRoleArn: string | undefined;
|
|
@@ -6686,7 +6684,7 @@ export interface StartTargetedSentimentDetectionJobResponse {
|
|
|
6686
6684
|
JobId?: string;
|
|
6687
6685
|
/**
|
|
6688
6686
|
* <p>The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully
|
|
6689
|
-
* qualified identifier for the job. It includes the
|
|
6687
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
6690
6688
|
* format of the ARN is as follows:</p>
|
|
6691
6689
|
* <p>
|
|
6692
6690
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id></code>
|
|
@@ -6732,8 +6730,8 @@ export interface StartTopicsDetectionJobRequest {
|
|
|
6732
6730
|
*/
|
|
6733
6731
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
6734
6732
|
/**
|
|
6735
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
6736
|
-
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/
|
|
6733
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
6734
|
+
* grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based permissions</a>.</p>
|
|
6737
6735
|
*/
|
|
6738
6736
|
DataAccessRoleArn: string | undefined;
|
|
6739
6737
|
/**
|
|
@@ -6750,7 +6748,7 @@ export interface StartTopicsDetectionJobRequest {
|
|
|
6750
6748
|
*/
|
|
6751
6749
|
ClientRequestToken?: string;
|
|
6752
6750
|
/**
|
|
6753
|
-
* <p>ID for the
|
|
6751
|
+
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
|
|
6754
6752
|
* data on the storage volume attached to the ML compute instance(s) that process the analysis
|
|
6755
6753
|
* job. The VolumeKmsKeyId can be either of the following formats:</p>
|
|
6756
6754
|
* <ul>
|
|
@@ -6790,7 +6788,7 @@ export interface StartTopicsDetectionJobResponse {
|
|
|
6790
6788
|
JobId?: string;
|
|
6791
6789
|
/**
|
|
6792
6790
|
* <p>The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully
|
|
6793
|
-
* qualified identifier for the job. It includes the
|
|
6791
|
+
* qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
|
|
6794
6792
|
* format of the ARN is as follows:</p>
|
|
6795
6793
|
* <p>
|
|
6796
6794
|
* <code>arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id></code>
|
|
@@ -167,7 +167,7 @@ export interface UpdateEndpointResponse {
|
|
|
167
167
|
*/
|
|
168
168
|
export interface UpdateDataSecurityConfig {
|
|
169
169
|
/**
|
|
170
|
-
* <p>ID for the
|
|
170
|
+
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt
|
|
171
171
|
* trained custom models. The ModelKmsKeyId can be either of the following formats:</p>
|
|
172
172
|
* <ul>
|
|
173
173
|
* <li>
|
|
@@ -206,7 +206,7 @@ export interface UpdateFlywheelRequest {
|
|
|
206
206
|
*/
|
|
207
207
|
ActiveModelArn?: string;
|
|
208
208
|
/**
|
|
209
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
209
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that
|
|
210
210
|
* grants Amazon Comprehend permission to access the flywheel data.</p>
|
|
211
211
|
*/
|
|
212
212
|
DataAccessRoleArn?: string;
|
|
@@ -815,6 +815,7 @@ export declare enum ModelStatus {
|
|
|
815
815
|
STOP_REQUESTED = "STOP_REQUESTED",
|
|
816
816
|
SUBMITTED = "SUBMITTED",
|
|
817
817
|
TRAINED = "TRAINED",
|
|
818
|
+
TRAINED_WITH_WARNING = "TRAINED_WITH_WARNING",
|
|
818
819
|
TRAINING = "TRAINING",
|
|
819
820
|
}
|
|
820
821
|
export interface DocumentClassifierProperties {
|
|
@@ -906,6 +907,7 @@ export interface EntitiesDetectionJobProperties {
|
|
|
906
907
|
DataAccessRoleArn?: string;
|
|
907
908
|
VolumeKmsKeyId?: string;
|
|
908
909
|
VpcConfig?: VpcConfig;
|
|
910
|
+
FlywheelArn?: string;
|
|
909
911
|
}
|
|
910
912
|
export interface DescribeEntitiesDetectionJobResponse {
|
|
911
913
|
EntitiesDetectionJobProperties?: EntitiesDetectionJobProperties;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-comprehend",
|
|
3
3
|
"description": "AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.299.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,22 +21,22 @@
|
|
|
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/config-resolver": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.299.0",
|
|
25
|
+
"@aws-sdk/config-resolver": "3.299.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.299.0",
|
|
27
27
|
"@aws-sdk/fetch-http-handler": "3.296.0",
|
|
28
28
|
"@aws-sdk/hash-node": "3.296.0",
|
|
29
29
|
"@aws-sdk/invalid-dependency": "3.296.0",
|
|
30
30
|
"@aws-sdk/middleware-content-length": "3.296.0",
|
|
31
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
31
|
+
"@aws-sdk/middleware-endpoint": "3.299.0",
|
|
32
32
|
"@aws-sdk/middleware-host-header": "3.296.0",
|
|
33
33
|
"@aws-sdk/middleware-logger": "3.296.0",
|
|
34
34
|
"@aws-sdk/middleware-recursion-detection": "3.296.0",
|
|
35
35
|
"@aws-sdk/middleware-retry": "3.296.0",
|
|
36
36
|
"@aws-sdk/middleware-serde": "3.296.0",
|
|
37
|
-
"@aws-sdk/middleware-signing": "3.
|
|
37
|
+
"@aws-sdk/middleware-signing": "3.299.0",
|
|
38
38
|
"@aws-sdk/middleware-stack": "3.296.0",
|
|
39
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
39
|
+
"@aws-sdk/middleware-user-agent": "3.299.0",
|
|
40
40
|
"@aws-sdk/node-config-provider": "3.296.0",
|
|
41
41
|
"@aws-sdk/node-http-handler": "3.296.0",
|
|
42
42
|
"@aws-sdk/protocol-http": "3.296.0",
|
|
@@ -47,11 +47,11 @@
|
|
|
47
47
|
"@aws-sdk/util-body-length-browser": "3.295.0",
|
|
48
48
|
"@aws-sdk/util-body-length-node": "3.295.0",
|
|
49
49
|
"@aws-sdk/util-defaults-mode-browser": "3.296.0",
|
|
50
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
50
|
+
"@aws-sdk/util-defaults-mode-node": "3.299.0",
|
|
51
51
|
"@aws-sdk/util-endpoints": "3.296.0",
|
|
52
52
|
"@aws-sdk/util-retry": "3.296.0",
|
|
53
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
54
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
53
|
+
"@aws-sdk/util-user-agent-browser": "3.299.0",
|
|
54
|
+
"@aws-sdk/util-user-agent-node": "3.299.0",
|
|
55
55
|
"@aws-sdk/util-utf8": "3.295.0",
|
|
56
56
|
"tslib": "^2.5.0",
|
|
57
57
|
"uuid": "^8.3.2"
|