aws-sdk 2.1342.0 → 2.1343.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/CHANGELOG.md +5 -1
- package/README.md +1 -1
- package/apis/comprehend-2017-11-27.min.json +2 -1
- package/clients/cloudwatch.d.ts +13 -13
- package/clients/comprehend.d.ts +110 -106
- package/clients/rds.d.ts +16 -16
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +2 -2
- package/dist/aws-sdk.js +5 -4
- package/dist/aws-sdk.min.js +3 -3
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/comprehend.d.ts
CHANGED
|
@@ -108,11 +108,11 @@ declare class Comprehend extends Service {
|
|
|
108
108
|
*/
|
|
109
109
|
createEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.CreateEntityRecognizerResponse) => void): Request<Comprehend.Types.CreateEntityRecognizerResponse, AWSError>;
|
|
110
110
|
/**
|
|
111
|
-
* A flywheel is an
|
|
111
|
+
* A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model. When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model. To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake. To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
|
|
112
112
|
*/
|
|
113
113
|
createFlywheel(params: Comprehend.Types.CreateFlywheelRequest, callback?: (err: AWSError, data: Comprehend.Types.CreateFlywheelResponse) => void): Request<Comprehend.Types.CreateFlywheelResponse, AWSError>;
|
|
114
114
|
/**
|
|
115
|
-
* A flywheel is an
|
|
115
|
+
* A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model. When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model. To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake. To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
|
|
116
116
|
*/
|
|
117
117
|
createFlywheel(callback?: (err: AWSError, data: Comprehend.Types.CreateFlywheelResponse) => void): Request<Comprehend.Types.CreateFlywheelResponse, AWSError>;
|
|
118
118
|
/**
|
|
@@ -340,19 +340,19 @@ declare class Comprehend extends Service {
|
|
|
340
340
|
*/
|
|
341
341
|
detectTargetedSentiment(callback?: (err: AWSError, data: Comprehend.Types.DetectTargetedSentimentResponse) => void): Request<Comprehend.Types.DetectTargetedSentimentResponse, AWSError>;
|
|
342
342
|
/**
|
|
343
|
-
* Creates a new custom model that replicates a source custom model that you import. The source model can be in your
|
|
343
|
+
* Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one. If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.
|
|
344
344
|
*/
|
|
345
345
|
importModel(params: Comprehend.Types.ImportModelRequest, callback?: (err: AWSError, data: Comprehend.Types.ImportModelResponse) => void): Request<Comprehend.Types.ImportModelResponse, AWSError>;
|
|
346
346
|
/**
|
|
347
|
-
* Creates a new custom model that replicates a source custom model that you import. The source model can be in your
|
|
347
|
+
* Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one. If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.
|
|
348
348
|
*/
|
|
349
349
|
importModel(callback?: (err: AWSError, data: Comprehend.Types.ImportModelResponse) => void): Request<Comprehend.Types.ImportModelResponse, AWSError>;
|
|
350
350
|
/**
|
|
351
|
-
* List the datasets that you have configured in this
|
|
351
|
+
* List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
|
|
352
352
|
*/
|
|
353
353
|
listDatasets(params: Comprehend.Types.ListDatasetsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListDatasetsResponse) => void): Request<Comprehend.Types.ListDatasetsResponse, AWSError>;
|
|
354
354
|
/**
|
|
355
|
-
* List the datasets that you have configured in this
|
|
355
|
+
* List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
|
|
356
356
|
*/
|
|
357
357
|
listDatasets(callback?: (err: AWSError, data: Comprehend.Types.ListDatasetsResponse) => void): Request<Comprehend.Types.ListDatasetsResponse, AWSError>;
|
|
358
358
|
/**
|
|
@@ -492,11 +492,11 @@ declare class Comprehend extends Service {
|
|
|
492
492
|
*/
|
|
493
493
|
listTopicsDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListTopicsDetectionJobsResponse) => void): Request<Comprehend.Types.ListTopicsDetectionJobsResponse, AWSError>;
|
|
494
494
|
/**
|
|
495
|
-
* Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another
|
|
495
|
+
* Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.
|
|
496
496
|
*/
|
|
497
497
|
putResourcePolicy(params: Comprehend.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: Comprehend.Types.PutResourcePolicyResponse) => void): Request<Comprehend.Types.PutResourcePolicyResponse, AWSError>;
|
|
498
498
|
/**
|
|
499
|
-
* Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another
|
|
499
|
+
* Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.
|
|
500
500
|
*/
|
|
501
501
|
putResourcePolicy(callback?: (err: AWSError, data: Comprehend.Types.PutResourcePolicyResponse) => void): Request<Comprehend.Types.PutResourcePolicyResponse, AWSError>;
|
|
502
502
|
/**
|
|
@@ -817,7 +817,7 @@ declare namespace Comprehend {
|
|
|
817
817
|
}
|
|
818
818
|
export interface BatchDetectSentimentRequest {
|
|
819
819
|
/**
|
|
820
|
-
* A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
|
|
820
|
+
* A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
|
|
821
821
|
*/
|
|
822
822
|
TextList: CustomerInputStringList;
|
|
823
823
|
/**
|
|
@@ -1145,11 +1145,11 @@ declare namespace Comprehend {
|
|
|
1145
1145
|
*/
|
|
1146
1146
|
DocumentClassifierName: ComprehendArnName;
|
|
1147
1147
|
/**
|
|
1148
|
-
* The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/
|
|
1148
|
+
* The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.
|
|
1149
1149
|
*/
|
|
1150
1150
|
VersionName?: VersionName;
|
|
1151
1151
|
/**
|
|
1152
|
-
* The Amazon Resource Name (ARN) of the
|
|
1152
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
1153
1153
|
*/
|
|
1154
1154
|
DataAccessRoleArn: IamRoleArn;
|
|
1155
1155
|
/**
|
|
@@ -1173,7 +1173,7 @@ declare namespace Comprehend {
|
|
|
1173
1173
|
*/
|
|
1174
1174
|
LanguageCode: LanguageCode;
|
|
1175
1175
|
/**
|
|
1176
|
-
* ID for the
|
|
1176
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
1177
1177
|
*/
|
|
1178
1178
|
VolumeKmsKeyId?: KmsKeyId;
|
|
1179
1179
|
/**
|
|
@@ -1185,11 +1185,11 @@ declare namespace Comprehend {
|
|
|
1185
1185
|
*/
|
|
1186
1186
|
Mode?: DocumentClassifierMode;
|
|
1187
1187
|
/**
|
|
1188
|
-
* ID for the
|
|
1188
|
+
* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
1189
1189
|
*/
|
|
1190
1190
|
ModelKmsKeyId?: KmsKeyId;
|
|
1191
1191
|
/**
|
|
1192
|
-
* The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another
|
|
1192
|
+
* The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services account to import your custom model. Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy: "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values: '{"attribute": "value", "attribute": ["value"]}'
|
|
1193
1193
|
*/
|
|
1194
1194
|
ModelPolicy?: Policy;
|
|
1195
1195
|
}
|
|
@@ -1221,7 +1221,7 @@ declare namespace Comprehend {
|
|
|
1221
1221
|
*/
|
|
1222
1222
|
Tags?: TagList;
|
|
1223
1223
|
/**
|
|
1224
|
-
* The Amazon Resource Name (ARN) of the
|
|
1224
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
|
|
1225
1225
|
*/
|
|
1226
1226
|
DataAccessRoleArn?: IamRoleArn;
|
|
1227
1227
|
/**
|
|
@@ -1241,15 +1241,15 @@ declare namespace Comprehend {
|
|
|
1241
1241
|
}
|
|
1242
1242
|
export interface CreateEntityRecognizerRequest {
|
|
1243
1243
|
/**
|
|
1244
|
-
* The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/
|
|
1244
|
+
* The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/Region.
|
|
1245
1245
|
*/
|
|
1246
1246
|
RecognizerName: ComprehendArnName;
|
|
1247
1247
|
/**
|
|
1248
|
-
* The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/
|
|
1248
|
+
* The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/Region.
|
|
1249
1249
|
*/
|
|
1250
1250
|
VersionName?: VersionName;
|
|
1251
1251
|
/**
|
|
1252
|
-
* The Amazon Resource Name (ARN) of the
|
|
1252
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
1253
1253
|
*/
|
|
1254
1254
|
DataAccessRoleArn: IamRoleArn;
|
|
1255
1255
|
/**
|
|
@@ -1257,7 +1257,7 @@ declare namespace Comprehend {
|
|
|
1257
1257
|
*/
|
|
1258
1258
|
Tags?: TagList;
|
|
1259
1259
|
/**
|
|
1260
|
-
* Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same
|
|
1260
|
+
* Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same Region as the entity recognizer being created.
|
|
1261
1261
|
*/
|
|
1262
1262
|
InputDataConfig: EntityRecognizerInputDataConfig;
|
|
1263
1263
|
/**
|
|
@@ -1269,7 +1269,7 @@ declare namespace Comprehend {
|
|
|
1269
1269
|
*/
|
|
1270
1270
|
LanguageCode: LanguageCode;
|
|
1271
1271
|
/**
|
|
1272
|
-
* ID for the
|
|
1272
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
1273
1273
|
*/
|
|
1274
1274
|
VolumeKmsKeyId?: KmsKeyId;
|
|
1275
1275
|
/**
|
|
@@ -1277,11 +1277,11 @@ declare namespace Comprehend {
|
|
|
1277
1277
|
*/
|
|
1278
1278
|
VpcConfig?: VpcConfig;
|
|
1279
1279
|
/**
|
|
1280
|
-
* ID for the
|
|
1280
|
+
* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
1281
1281
|
*/
|
|
1282
1282
|
ModelKmsKeyId?: KmsKeyId;
|
|
1283
1283
|
/**
|
|
1284
|
-
* The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another
|
|
1284
|
+
* The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy: "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values: '{"attribute": "value", "attribute": ["value"]}'
|
|
1285
1285
|
*/
|
|
1286
1286
|
ModelPolicy?: Policy;
|
|
1287
1287
|
}
|
|
@@ -1301,7 +1301,7 @@ declare namespace Comprehend {
|
|
|
1301
1301
|
*/
|
|
1302
1302
|
ActiveModelArn?: ComprehendModelArn;
|
|
1303
1303
|
/**
|
|
1304
|
-
* The Amazon Resource Name (ARN) of the
|
|
1304
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.
|
|
1305
1305
|
*/
|
|
1306
1306
|
DataAccessRoleArn: IamRoleArn;
|
|
1307
1307
|
/**
|
|
@@ -1343,7 +1343,7 @@ declare namespace Comprehend {
|
|
|
1343
1343
|
export type CustomerInputStringList = CustomerInputString[];
|
|
1344
1344
|
export interface DataSecurityConfig {
|
|
1345
1345
|
/**
|
|
1346
|
-
* ID for the
|
|
1346
|
+
* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
1347
1347
|
*/
|
|
1348
1348
|
ModelKmsKeyId?: KmsKeyId;
|
|
1349
1349
|
/**
|
|
@@ -1382,7 +1382,7 @@ declare namespace Comprehend {
|
|
|
1382
1382
|
export type DatasetDataFormat = "COMPREHEND_CSV"|"AUGMENTED_MANIFEST"|string;
|
|
1383
1383
|
export interface DatasetDocumentClassifierInputDataConfig {
|
|
1384
1384
|
/**
|
|
1385
|
-
* The Amazon S3 URI for the input data. The S3 bucket must be in the same
|
|
1385
|
+
* The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files. For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input. This parameter is required if you set DataFormat to COMPREHEND_CSV.
|
|
1386
1386
|
*/
|
|
1387
1387
|
S3Uri: S3Uri;
|
|
1388
1388
|
/**
|
|
@@ -1392,7 +1392,7 @@ declare namespace Comprehend {
|
|
|
1392
1392
|
}
|
|
1393
1393
|
export interface DatasetEntityRecognizerAnnotations {
|
|
1394
1394
|
/**
|
|
1395
|
-
* Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same
|
|
1395
|
+
* Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.
|
|
1396
1396
|
*/
|
|
1397
1397
|
S3Uri: S3Uri;
|
|
1398
1398
|
}
|
|
@@ -1765,7 +1765,7 @@ declare namespace Comprehend {
|
|
|
1765
1765
|
}
|
|
1766
1766
|
export interface DetectDominantLanguageResponse {
|
|
1767
1767
|
/**
|
|
1768
|
-
*
|
|
1768
|
+
* Array of languages that Amazon Comprehend detected in the input text. The array is sorted in descending order of the score (the dominant language is always the first element in the array). For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
|
|
1769
1769
|
*/
|
|
1770
1770
|
Languages?: ListOfDominantLanguages;
|
|
1771
1771
|
}
|
|
@@ -1847,7 +1847,7 @@ declare namespace Comprehend {
|
|
|
1847
1847
|
}
|
|
1848
1848
|
export interface DetectSentimentRequest {
|
|
1849
1849
|
/**
|
|
1850
|
-
* A UTF-8 text string. The maximum string size is 5 KB.
|
|
1850
|
+
* A UTF-8 text string. The maximum string size is 5 KB.
|
|
1851
1851
|
*/
|
|
1852
1852
|
Text: CustomerInputString;
|
|
1853
1853
|
/**
|
|
@@ -1945,7 +1945,7 @@ declare namespace Comprehend {
|
|
|
1945
1945
|
*/
|
|
1946
1946
|
JobId?: JobId;
|
|
1947
1947
|
/**
|
|
1948
|
-
* The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the
|
|
1948
|
+
* The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
|
|
1949
1949
|
*/
|
|
1950
1950
|
JobArn?: ComprehendArn;
|
|
1951
1951
|
/**
|
|
@@ -1981,11 +1981,11 @@ declare namespace Comprehend {
|
|
|
1981
1981
|
*/
|
|
1982
1982
|
OutputDataConfig?: OutputDataConfig;
|
|
1983
1983
|
/**
|
|
1984
|
-
* The Amazon Resource Name (ARN) of the
|
|
1984
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
1985
1985
|
*/
|
|
1986
1986
|
DataAccessRoleArn?: IamRoleArn;
|
|
1987
1987
|
/**
|
|
1988
|
-
* ID for the
|
|
1988
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
1989
1989
|
*/
|
|
1990
1990
|
VolumeKmsKeyId?: KmsKeyId;
|
|
1991
1991
|
/**
|
|
@@ -2026,11 +2026,11 @@ declare namespace Comprehend {
|
|
|
2026
2026
|
*/
|
|
2027
2027
|
DataFormat?: DocumentClassifierDataFormat;
|
|
2028
2028
|
/**
|
|
2029
|
-
* The Amazon S3 URI for the input data. The S3 bucket must be in the same
|
|
2029
|
+
* The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files. For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input. This parameter is required if you set DataFormat to COMPREHEND_CSV.
|
|
2030
2030
|
*/
|
|
2031
2031
|
S3Uri?: S3Uri;
|
|
2032
2032
|
/**
|
|
2033
|
-
* This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same
|
|
2033
|
+
* This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.
|
|
2034
2034
|
*/
|
|
2035
2035
|
TestS3Uri?: S3Uri;
|
|
2036
2036
|
/**
|
|
@@ -2045,11 +2045,11 @@ declare namespace Comprehend {
|
|
|
2045
2045
|
export type DocumentClassifierMode = "MULTI_CLASS"|"MULTI_LABEL"|string;
|
|
2046
2046
|
export interface DocumentClassifierOutputDataConfig {
|
|
2047
2047
|
/**
|
|
2048
|
-
* When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the same
|
|
2048
|
+
* When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file. When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.
|
|
2049
2049
|
*/
|
|
2050
2050
|
S3Uri?: S3Uri;
|
|
2051
2051
|
/**
|
|
2052
|
-
* ID for the
|
|
2052
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" KMS Key Alias: "alias/ExampleAlias" ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
|
|
2053
2053
|
*/
|
|
2054
2054
|
KmsKeyId?: KmsKeyId;
|
|
2055
2055
|
/**
|
|
@@ -2103,11 +2103,11 @@ declare namespace Comprehend {
|
|
|
2103
2103
|
*/
|
|
2104
2104
|
ClassifierMetadata?: ClassifierMetadata;
|
|
2105
2105
|
/**
|
|
2106
|
-
* The Amazon Resource Name (ARN) of the
|
|
2106
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
2107
2107
|
*/
|
|
2108
2108
|
DataAccessRoleArn?: IamRoleArn;
|
|
2109
2109
|
/**
|
|
2110
|
-
* ID for the
|
|
2110
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
2111
2111
|
*/
|
|
2112
2112
|
VolumeKmsKeyId?: KmsKeyId;
|
|
2113
2113
|
/**
|
|
@@ -2119,7 +2119,7 @@ declare namespace Comprehend {
|
|
|
2119
2119
|
*/
|
|
2120
2120
|
Mode?: DocumentClassifierMode;
|
|
2121
2121
|
/**
|
|
2122
|
-
* ID for the
|
|
2122
|
+
* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
2123
2123
|
*/
|
|
2124
2124
|
ModelKmsKeyId?: KmsKeyId;
|
|
2125
2125
|
/**
|
|
@@ -2127,7 +2127,7 @@ declare namespace Comprehend {
|
|
|
2127
2127
|
*/
|
|
2128
2128
|
VersionName?: VersionName;
|
|
2129
2129
|
/**
|
|
2130
|
-
* The Amazon Resource Name (ARN) of the source model. This model was imported from a different
|
|
2130
|
+
* The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.
|
|
2131
2131
|
*/
|
|
2132
2132
|
SourceModelArn?: DocumentClassifierArn;
|
|
2133
2133
|
/**
|
|
@@ -2245,7 +2245,7 @@ declare namespace Comprehend {
|
|
|
2245
2245
|
*/
|
|
2246
2246
|
JobId?: JobId;
|
|
2247
2247
|
/**
|
|
2248
|
-
* The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
2248
|
+
* The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
2249
2249
|
*/
|
|
2250
2250
|
JobArn?: ComprehendArn;
|
|
2251
2251
|
/**
|
|
@@ -2277,11 +2277,11 @@ declare namespace Comprehend {
|
|
|
2277
2277
|
*/
|
|
2278
2278
|
OutputDataConfig?: OutputDataConfig;
|
|
2279
2279
|
/**
|
|
2280
|
-
* The Amazon Resource Name (ARN) of the
|
|
2280
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
2281
2281
|
*/
|
|
2282
2282
|
DataAccessRoleArn?: IamRoleArn;
|
|
2283
2283
|
/**
|
|
2284
|
-
* ID for the
|
|
2284
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
2285
2285
|
*/
|
|
2286
2286
|
VolumeKmsKeyId?: KmsKeyId;
|
|
2287
2287
|
/**
|
|
@@ -2347,7 +2347,7 @@ declare namespace Comprehend {
|
|
|
2347
2347
|
*/
|
|
2348
2348
|
LastModifiedTime?: Timestamp;
|
|
2349
2349
|
/**
|
|
2350
|
-
* The Amazon Resource Name (ARN) of the
|
|
2350
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
|
|
2351
2351
|
*/
|
|
2352
2352
|
DataAccessRoleArn?: IamRoleArn;
|
|
2353
2353
|
/**
|
|
@@ -2385,7 +2385,7 @@ declare namespace Comprehend {
|
|
|
2385
2385
|
*/
|
|
2386
2386
|
JobId?: JobId;
|
|
2387
2387
|
/**
|
|
2388
|
-
* The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
2388
|
+
* The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
2389
2389
|
*/
|
|
2390
2390
|
JobArn?: ComprehendArn;
|
|
2391
2391
|
/**
|
|
@@ -2425,17 +2425,21 @@ declare namespace Comprehend {
|
|
|
2425
2425
|
*/
|
|
2426
2426
|
LanguageCode?: LanguageCode;
|
|
2427
2427
|
/**
|
|
2428
|
-
* The Amazon Resource Name (ARN) of the
|
|
2428
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
2429
2429
|
*/
|
|
2430
2430
|
DataAccessRoleArn?: IamRoleArn;
|
|
2431
2431
|
/**
|
|
2432
|
-
* ID for the
|
|
2432
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
2433
2433
|
*/
|
|
2434
2434
|
VolumeKmsKeyId?: KmsKeyId;
|
|
2435
2435
|
/**
|
|
2436
2436
|
* Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
|
|
2437
2437
|
*/
|
|
2438
2438
|
VpcConfig?: VpcConfig;
|
|
2439
|
+
/**
|
|
2440
|
+
* The Amazon Resource Name (ARN) of the flywheel associated with this job.
|
|
2441
|
+
*/
|
|
2442
|
+
FlywheelArn?: ComprehendFlywheelArn;
|
|
2439
2443
|
}
|
|
2440
2444
|
export type EntitiesDetectionJobPropertiesList = EntitiesDetectionJobProperties[];
|
|
2441
2445
|
export interface Entity {
|
|
@@ -2482,11 +2486,11 @@ declare namespace Comprehend {
|
|
|
2482
2486
|
}
|
|
2483
2487
|
export interface EntityRecognizerAnnotations {
|
|
2484
2488
|
/**
|
|
2485
|
-
* Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same
|
|
2489
|
+
* Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.
|
|
2486
2490
|
*/
|
|
2487
2491
|
S3Uri: S3Uri;
|
|
2488
2492
|
/**
|
|
2489
|
-
* Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same
|
|
2493
|
+
* Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.
|
|
2490
2494
|
*/
|
|
2491
2495
|
TestS3Uri?: S3Uri;
|
|
2492
2496
|
}
|
|
@@ -2495,11 +2499,11 @@ declare namespace Comprehend {
|
|
|
2495
2499
|
export type EntityRecognizerDataFormat = "COMPREHEND_CSV"|"AUGMENTED_MANIFEST"|string;
|
|
2496
2500
|
export interface EntityRecognizerDocuments {
|
|
2497
2501
|
/**
|
|
2498
|
-
* Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same
|
|
2502
|
+
* Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.
|
|
2499
2503
|
*/
|
|
2500
2504
|
S3Uri: S3Uri;
|
|
2501
2505
|
/**
|
|
2502
|
-
* Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same
|
|
2506
|
+
* Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.
|
|
2503
2507
|
*/
|
|
2504
2508
|
TestS3Uri?: S3Uri;
|
|
2505
2509
|
/**
|
|
@@ -2510,7 +2514,7 @@ declare namespace Comprehend {
|
|
|
2510
2514
|
export type EntityRecognizerEndpointArn = string;
|
|
2511
2515
|
export interface EntityRecognizerEntityList {
|
|
2512
2516
|
/**
|
|
2513
|
-
* Specifies the Amazon S3 location where the entity list is located. The URI must be in the same
|
|
2517
|
+
* Specifies the Amazon S3 location where the entity list is located. The URI must be in the same Region as the API endpoint that you are calling.
|
|
2514
2518
|
*/
|
|
2515
2519
|
S3Uri: S3Uri;
|
|
2516
2520
|
}
|
|
@@ -2653,11 +2657,11 @@ declare namespace Comprehend {
|
|
|
2653
2657
|
*/
|
|
2654
2658
|
RecognizerMetadata?: EntityRecognizerMetadata;
|
|
2655
2659
|
/**
|
|
2656
|
-
* The Amazon Resource Name (ARN) of the
|
|
2660
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
2657
2661
|
*/
|
|
2658
2662
|
DataAccessRoleArn?: IamRoleArn;
|
|
2659
2663
|
/**
|
|
2660
|
-
* ID for the
|
|
2664
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
2661
2665
|
*/
|
|
2662
2666
|
VolumeKmsKeyId?: KmsKeyId;
|
|
2663
2667
|
/**
|
|
@@ -2665,7 +2669,7 @@ declare namespace Comprehend {
|
|
|
2665
2669
|
*/
|
|
2666
2670
|
VpcConfig?: VpcConfig;
|
|
2667
2671
|
/**
|
|
2668
|
-
* ID for the
|
|
2672
|
+
* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
2669
2673
|
*/
|
|
2670
2674
|
ModelKmsKeyId?: KmsKeyId;
|
|
2671
2675
|
/**
|
|
@@ -2673,7 +2677,7 @@ declare namespace Comprehend {
|
|
|
2673
2677
|
*/
|
|
2674
2678
|
VersionName?: VersionName;
|
|
2675
2679
|
/**
|
|
2676
|
-
* The Amazon Resource Name (ARN) of the source model. This model was imported from a different
|
|
2680
|
+
* The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.
|
|
2677
2681
|
*/
|
|
2678
2682
|
SourceModelArn?: EntityRecognizerArn;
|
|
2679
2683
|
/**
|
|
@@ -2771,7 +2775,7 @@ declare namespace Comprehend {
|
|
|
2771
2775
|
*/
|
|
2772
2776
|
JobId?: JobId;
|
|
2773
2777
|
/**
|
|
2774
|
-
* The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
2778
|
+
* The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
2775
2779
|
*/
|
|
2776
2780
|
JobArn?: ComprehendArn;
|
|
2777
2781
|
/**
|
|
@@ -2807,7 +2811,7 @@ declare namespace Comprehend {
|
|
|
2807
2811
|
*/
|
|
2808
2812
|
LanguageCode?: LanguageCode;
|
|
2809
2813
|
/**
|
|
2810
|
-
* The Amazon Resource Name (ARN) of the
|
|
2814
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
2811
2815
|
*/
|
|
2812
2816
|
DataAccessRoleArn?: IamRoleArn;
|
|
2813
2817
|
/**
|
|
@@ -2925,7 +2929,7 @@ declare namespace Comprehend {
|
|
|
2925
2929
|
*/
|
|
2926
2930
|
ActiveModelArn?: ComprehendModelArn;
|
|
2927
2931
|
/**
|
|
2928
|
-
* The Amazon Resource Name (ARN) of the
|
|
2932
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
|
|
2929
2933
|
*/
|
|
2930
2934
|
DataAccessRoleArn?: IamRoleArn;
|
|
2931
2935
|
/**
|
|
@@ -3027,15 +3031,15 @@ declare namespace Comprehend {
|
|
|
3027
3031
|
*/
|
|
3028
3032
|
ModelName?: ComprehendArnName;
|
|
3029
3033
|
/**
|
|
3030
|
-
* The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/
|
|
3034
|
+
* The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/Region.
|
|
3031
3035
|
*/
|
|
3032
3036
|
VersionName?: VersionName;
|
|
3033
3037
|
/**
|
|
3034
|
-
* ID for the
|
|
3038
|
+
* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
3035
3039
|
*/
|
|
3036
3040
|
ModelKmsKeyId?: KmsKeyId;
|
|
3037
3041
|
/**
|
|
3038
|
-
* The Amazon Resource Name (ARN) of the
|
|
3042
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
|
|
3039
3043
|
*/
|
|
3040
3044
|
DataAccessRoleArn?: IamRoleArn;
|
|
3041
3045
|
/**
|
|
@@ -3052,7 +3056,7 @@ declare namespace Comprehend {
|
|
|
3052
3056
|
export type InferenceUnitsInteger = number;
|
|
3053
3057
|
export interface InputDataConfig {
|
|
3054
3058
|
/**
|
|
3055
|
-
* The Amazon S3 URI for the input data. The URI must be in same
|
|
3059
|
+
* The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files. For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
|
|
3056
3060
|
*/
|
|
3057
3061
|
S3Uri: S3Uri;
|
|
3058
3062
|
/**
|
|
@@ -3111,7 +3115,7 @@ declare namespace Comprehend {
|
|
|
3111
3115
|
*/
|
|
3112
3116
|
JobId?: JobId;
|
|
3113
3117
|
/**
|
|
3114
|
-
* The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
3118
|
+
* The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
3115
3119
|
*/
|
|
3116
3120
|
JobArn?: ComprehendArn;
|
|
3117
3121
|
/**
|
|
@@ -3147,11 +3151,11 @@ declare namespace Comprehend {
|
|
|
3147
3151
|
*/
|
|
3148
3152
|
LanguageCode?: LanguageCode;
|
|
3149
3153
|
/**
|
|
3150
|
-
* The Amazon Resource Name (ARN) of the
|
|
3154
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
3151
3155
|
*/
|
|
3152
3156
|
DataAccessRoleArn?: IamRoleArn;
|
|
3153
3157
|
/**
|
|
3154
|
-
* ID for the
|
|
3158
|
+
* ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
3155
3159
|
*/
|
|
3156
3160
|
VolumeKmsKeyId?: KmsKeyId;
|
|
3157
3161
|
/**
|
|
@@ -3624,17 +3628,17 @@ declare namespace Comprehend {
|
|
|
3624
3628
|
Sentiment?: SentimentType;
|
|
3625
3629
|
SentimentScore?: SentimentScore;
|
|
3626
3630
|
}
|
|
3627
|
-
export type ModelStatus = "SUBMITTED"|"TRAINING"|"DELETING"|"STOP_REQUESTED"|"STOPPED"|"IN_ERROR"|"TRAINED"|string;
|
|
3631
|
+
export type ModelStatus = "SUBMITTED"|"TRAINING"|"DELETING"|"STOP_REQUESTED"|"STOPPED"|"IN_ERROR"|"TRAINED"|"TRAINED_WITH_WARNING"|string;
|
|
3628
3632
|
export type ModelType = "DOCUMENT_CLASSIFIER"|"ENTITY_RECOGNIZER"|string;
|
|
3629
3633
|
export type NumberOfDocuments = number;
|
|
3630
3634
|
export type NumberOfTopicsInteger = number;
|
|
3631
3635
|
export interface OutputDataConfig {
|
|
3632
3636
|
/**
|
|
3633
|
-
* When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same
|
|
3637
|
+
* When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file. When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation. For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
|
|
3634
3638
|
*/
|
|
3635
3639
|
S3Uri: S3Uri;
|
|
3636
3640
|
/**
|
|
3637
|
-
* ID for the
|
|
3641
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" KMS Key Alias: "alias/ExampleAlias" ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
|
|
3638
3642
|
*/
|
|
3639
3643
|
KmsKeyId?: KmsKeyId;
|
|
3640
3644
|
}
|
|
@@ -3674,7 +3678,7 @@ declare namespace Comprehend {
|
|
|
3674
3678
|
*/
|
|
3675
3679
|
JobId?: JobId;
|
|
3676
3680
|
/**
|
|
3677
|
-
* The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
3681
|
+
* The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
3678
3682
|
*/
|
|
3679
3683
|
JobArn?: ComprehendArn;
|
|
3680
3684
|
/**
|
|
@@ -3714,7 +3718,7 @@ declare namespace Comprehend {
|
|
|
3714
3718
|
*/
|
|
3715
3719
|
LanguageCode?: LanguageCode;
|
|
3716
3720
|
/**
|
|
3717
|
-
* The Amazon Resource Name (ARN) of the
|
|
3721
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
3718
3722
|
*/
|
|
3719
3723
|
DataAccessRoleArn?: IamRoleArn;
|
|
3720
3724
|
/**
|
|
@@ -3750,7 +3754,7 @@ declare namespace Comprehend {
|
|
|
3750
3754
|
*/
|
|
3751
3755
|
S3Uri: S3Uri;
|
|
3752
3756
|
/**
|
|
3753
|
-
* ID for the
|
|
3757
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
|
|
3754
3758
|
*/
|
|
3755
3759
|
KmsKeyId?: KmsKeyId;
|
|
3756
3760
|
}
|
|
@@ -3840,7 +3844,7 @@ declare namespace Comprehend {
|
|
|
3840
3844
|
*/
|
|
3841
3845
|
JobId?: JobId;
|
|
3842
3846
|
/**
|
|
3843
|
-
* The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
3847
|
+
* The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
3844
3848
|
*/
|
|
3845
3849
|
JobArn?: ComprehendArn;
|
|
3846
3850
|
/**
|
|
@@ -3876,11 +3880,11 @@ declare namespace Comprehend {
|
|
|
3876
3880
|
*/
|
|
3877
3881
|
LanguageCode?: LanguageCode;
|
|
3878
3882
|
/**
|
|
3879
|
-
* The Amazon Resource Name (ARN) of the
|
|
3883
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
3880
3884
|
*/
|
|
3881
3885
|
DataAccessRoleArn?: IamRoleArn;
|
|
3882
3886
|
/**
|
|
3883
|
-
* ID for the
|
|
3887
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
3884
3888
|
*/
|
|
3885
3889
|
VolumeKmsKeyId?: KmsKeyId;
|
|
3886
3890
|
/**
|
|
@@ -3927,7 +3931,7 @@ declare namespace Comprehend {
|
|
|
3927
3931
|
*/
|
|
3928
3932
|
OutputDataConfig: OutputDataConfig;
|
|
3929
3933
|
/**
|
|
3930
|
-
* The Amazon Resource Name (ARN) of the
|
|
3934
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
3931
3935
|
*/
|
|
3932
3936
|
DataAccessRoleArn: IamRoleArn;
|
|
3933
3937
|
/**
|
|
@@ -3935,7 +3939,7 @@ declare namespace Comprehend {
|
|
|
3935
3939
|
*/
|
|
3936
3940
|
ClientRequestToken?: ClientRequestTokenString;
|
|
3937
3941
|
/**
|
|
3938
|
-
* ID for the
|
|
3942
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
3939
3943
|
*/
|
|
3940
3944
|
VolumeKmsKeyId?: KmsKeyId;
|
|
3941
3945
|
/**
|
|
@@ -3957,7 +3961,7 @@ declare namespace Comprehend {
|
|
|
3957
3961
|
*/
|
|
3958
3962
|
JobId?: JobId;
|
|
3959
3963
|
/**
|
|
3960
|
-
* The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the
|
|
3964
|
+
* The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
|
|
3961
3965
|
*/
|
|
3962
3966
|
JobArn?: ComprehendArn;
|
|
3963
3967
|
/**
|
|
@@ -3979,7 +3983,7 @@ declare namespace Comprehend {
|
|
|
3979
3983
|
*/
|
|
3980
3984
|
OutputDataConfig: OutputDataConfig;
|
|
3981
3985
|
/**
|
|
3982
|
-
* The Amazon Resource Name (ARN) of the
|
|
3986
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
|
|
3983
3987
|
*/
|
|
3984
3988
|
DataAccessRoleArn: IamRoleArn;
|
|
3985
3989
|
/**
|
|
@@ -3991,7 +3995,7 @@ declare namespace Comprehend {
|
|
|
3991
3995
|
*/
|
|
3992
3996
|
ClientRequestToken?: ClientRequestTokenString;
|
|
3993
3997
|
/**
|
|
3994
|
-
* ID for the
|
|
3998
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
3995
3999
|
*/
|
|
3996
4000
|
VolumeKmsKeyId?: KmsKeyId;
|
|
3997
4001
|
/**
|
|
@@ -4009,7 +4013,7 @@ declare namespace Comprehend {
|
|
|
4009
4013
|
*/
|
|
4010
4014
|
JobId?: JobId;
|
|
4011
4015
|
/**
|
|
4012
|
-
* The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
4016
|
+
* The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
4013
4017
|
*/
|
|
4014
4018
|
JobArn?: ComprehendArn;
|
|
4015
4019
|
/**
|
|
@@ -4027,7 +4031,7 @@ declare namespace Comprehend {
|
|
|
4027
4031
|
*/
|
|
4028
4032
|
OutputDataConfig: OutputDataConfig;
|
|
4029
4033
|
/**
|
|
4030
|
-
* The Amazon Resource Name (ARN) of the
|
|
4034
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
|
|
4031
4035
|
*/
|
|
4032
4036
|
DataAccessRoleArn: IamRoleArn;
|
|
4033
4037
|
/**
|
|
@@ -4047,7 +4051,7 @@ declare namespace Comprehend {
|
|
|
4047
4051
|
*/
|
|
4048
4052
|
ClientRequestToken?: ClientRequestTokenString;
|
|
4049
4053
|
/**
|
|
4050
|
-
* ID for the
|
|
4054
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
4051
4055
|
*/
|
|
4052
4056
|
VolumeKmsKeyId?: KmsKeyId;
|
|
4053
4057
|
/**
|
|
@@ -4069,7 +4073,7 @@ declare namespace Comprehend {
|
|
|
4069
4073
|
*/
|
|
4070
4074
|
JobId?: JobId;
|
|
4071
4075
|
/**
|
|
4072
|
-
* The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
4076
|
+
* The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
4073
4077
|
*/
|
|
4074
4078
|
JobArn?: ComprehendArn;
|
|
4075
4079
|
/**
|
|
@@ -4091,7 +4095,7 @@ declare namespace Comprehend {
|
|
|
4091
4095
|
*/
|
|
4092
4096
|
OutputDataConfig: OutputDataConfig;
|
|
4093
4097
|
/**
|
|
4094
|
-
* The Amazon Resource Name (ARN) of the
|
|
4098
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
4095
4099
|
*/
|
|
4096
4100
|
DataAccessRoleArn: IamRoleArn;
|
|
4097
4101
|
/**
|
|
@@ -4121,7 +4125,7 @@ declare namespace Comprehend {
|
|
|
4121
4125
|
*/
|
|
4122
4126
|
JobId?: JobId;
|
|
4123
4127
|
/**
|
|
4124
|
-
* The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
4128
|
+
* The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
4125
4129
|
*/
|
|
4126
4130
|
JobArn?: ComprehendArn;
|
|
4127
4131
|
/**
|
|
@@ -4159,7 +4163,7 @@ declare namespace Comprehend {
|
|
|
4159
4163
|
*/
|
|
4160
4164
|
OutputDataConfig: OutputDataConfig;
|
|
4161
4165
|
/**
|
|
4162
|
-
* The Amazon Resource Name (ARN) of the
|
|
4166
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
|
|
4163
4167
|
*/
|
|
4164
4168
|
DataAccessRoleArn: IamRoleArn;
|
|
4165
4169
|
/**
|
|
@@ -4175,7 +4179,7 @@ declare namespace Comprehend {
|
|
|
4175
4179
|
*/
|
|
4176
4180
|
ClientRequestToken?: ClientRequestTokenString;
|
|
4177
4181
|
/**
|
|
4178
|
-
* ID for the
|
|
4182
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
4179
4183
|
*/
|
|
4180
4184
|
VolumeKmsKeyId?: KmsKeyId;
|
|
4181
4185
|
/**
|
|
@@ -4193,7 +4197,7 @@ declare namespace Comprehend {
|
|
|
4193
4197
|
*/
|
|
4194
4198
|
JobId?: JobId;
|
|
4195
4199
|
/**
|
|
4196
|
-
* The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
4200
|
+
* The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
4197
4201
|
*/
|
|
4198
4202
|
JobArn?: ComprehendArn;
|
|
4199
4203
|
/**
|
|
@@ -4219,7 +4223,7 @@ declare namespace Comprehend {
|
|
|
4219
4223
|
*/
|
|
4220
4224
|
RedactionConfig?: RedactionConfig;
|
|
4221
4225
|
/**
|
|
4222
|
-
* The Amazon Resource Name (ARN) of the
|
|
4226
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
4223
4227
|
*/
|
|
4224
4228
|
DataAccessRoleArn: IamRoleArn;
|
|
4225
4229
|
/**
|
|
@@ -4245,7 +4249,7 @@ declare namespace Comprehend {
|
|
|
4245
4249
|
*/
|
|
4246
4250
|
JobId?: JobId;
|
|
4247
4251
|
/**
|
|
4248
|
-
* The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
4252
|
+
* The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
4249
4253
|
*/
|
|
4250
4254
|
JobArn?: ComprehendArn;
|
|
4251
4255
|
/**
|
|
@@ -4263,7 +4267,7 @@ declare namespace Comprehend {
|
|
|
4263
4267
|
*/
|
|
4264
4268
|
OutputDataConfig: OutputDataConfig;
|
|
4265
4269
|
/**
|
|
4266
|
-
* The Amazon Resource Name (ARN) of the
|
|
4270
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
|
|
4267
4271
|
*/
|
|
4268
4272
|
DataAccessRoleArn: IamRoleArn;
|
|
4269
4273
|
/**
|
|
@@ -4279,7 +4283,7 @@ declare namespace Comprehend {
|
|
|
4279
4283
|
*/
|
|
4280
4284
|
ClientRequestToken?: ClientRequestTokenString;
|
|
4281
4285
|
/**
|
|
4282
|
-
* ID for the
|
|
4286
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
4283
4287
|
*/
|
|
4284
4288
|
VolumeKmsKeyId?: KmsKeyId;
|
|
4285
4289
|
/**
|
|
@@ -4297,7 +4301,7 @@ declare namespace Comprehend {
|
|
|
4297
4301
|
*/
|
|
4298
4302
|
JobId?: JobId;
|
|
4299
4303
|
/**
|
|
4300
|
-
* The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
4304
|
+
* The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
4301
4305
|
*/
|
|
4302
4306
|
JobArn?: ComprehendArn;
|
|
4303
4307
|
/**
|
|
@@ -4312,7 +4316,7 @@ declare namespace Comprehend {
|
|
|
4312
4316
|
*/
|
|
4313
4317
|
OutputDataConfig: OutputDataConfig;
|
|
4314
4318
|
/**
|
|
4315
|
-
* The Amazon Resource Name (ARN) of the
|
|
4319
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
|
|
4316
4320
|
*/
|
|
4317
4321
|
DataAccessRoleArn: IamRoleArn;
|
|
4318
4322
|
/**
|
|
@@ -4343,7 +4347,7 @@ declare namespace Comprehend {
|
|
|
4343
4347
|
*/
|
|
4344
4348
|
JobId?: JobId;
|
|
4345
4349
|
/**
|
|
4346
|
-
* The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
4350
|
+
* The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
4347
4351
|
*/
|
|
4348
4352
|
JobArn?: ComprehendArn;
|
|
4349
4353
|
/**
|
|
@@ -4361,7 +4365,7 @@ declare namespace Comprehend {
|
|
|
4361
4365
|
*/
|
|
4362
4366
|
OutputDataConfig: OutputDataConfig;
|
|
4363
4367
|
/**
|
|
4364
|
-
* The Amazon Resource Name (ARN) of the
|
|
4368
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
|
|
4365
4369
|
*/
|
|
4366
4370
|
DataAccessRoleArn: IamRoleArn;
|
|
4367
4371
|
/**
|
|
@@ -4377,7 +4381,7 @@ declare namespace Comprehend {
|
|
|
4377
4381
|
*/
|
|
4378
4382
|
ClientRequestToken?: ClientRequestTokenString;
|
|
4379
4383
|
/**
|
|
4380
|
-
* ID for the
|
|
4384
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
4381
4385
|
*/
|
|
4382
4386
|
VolumeKmsKeyId?: KmsKeyId;
|
|
4383
4387
|
/**
|
|
@@ -4395,7 +4399,7 @@ declare namespace Comprehend {
|
|
|
4395
4399
|
*/
|
|
4396
4400
|
JobId?: JobId;
|
|
4397
4401
|
/**
|
|
4398
|
-
* The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
4402
|
+
* The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
|
|
4399
4403
|
*/
|
|
4400
4404
|
JobArn?: ComprehendArn;
|
|
4401
4405
|
/**
|
|
@@ -4609,7 +4613,7 @@ declare namespace Comprehend {
|
|
|
4609
4613
|
*/
|
|
4610
4614
|
JobId?: JobId;
|
|
4611
4615
|
/**
|
|
4612
|
-
* The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
4616
|
+
* The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
4613
4617
|
*/
|
|
4614
4618
|
JobArn?: ComprehendArn;
|
|
4615
4619
|
/**
|
|
@@ -4639,7 +4643,7 @@ declare namespace Comprehend {
|
|
|
4639
4643
|
*/
|
|
4640
4644
|
LanguageCode?: LanguageCode;
|
|
4641
4645
|
/**
|
|
4642
|
-
* The Amazon Resource Name (ARN) of the
|
|
4646
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
|
4643
4647
|
*/
|
|
4644
4648
|
DataAccessRoleArn?: IamRoleArn;
|
|
4645
4649
|
/**
|
|
@@ -4729,7 +4733,7 @@ declare namespace Comprehend {
|
|
|
4729
4733
|
*/
|
|
4730
4734
|
JobId?: JobId;
|
|
4731
4735
|
/**
|
|
4732
|
-
* The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the
|
|
4736
|
+
* The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows: arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
|
|
4733
4737
|
*/
|
|
4734
4738
|
JobArn?: ComprehendArn;
|
|
4735
4739
|
/**
|
|
@@ -4765,11 +4769,11 @@ declare namespace Comprehend {
|
|
|
4765
4769
|
*/
|
|
4766
4770
|
NumberOfTopics?: Integer;
|
|
4767
4771
|
/**
|
|
4768
|
-
* The Amazon Resource Name (ARN) of the
|
|
4772
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data.
|
|
4769
4773
|
*/
|
|
4770
4774
|
DataAccessRoleArn?: IamRoleArn;
|
|
4771
4775
|
/**
|
|
4772
|
-
* ID for the
|
|
4776
|
+
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
4773
4777
|
*/
|
|
4774
4778
|
VolumeKmsKeyId?: KmsKeyId;
|
|
4775
4779
|
/**
|
|
@@ -4792,7 +4796,7 @@ declare namespace Comprehend {
|
|
|
4792
4796
|
}
|
|
4793
4797
|
export interface UpdateDataSecurityConfig {
|
|
4794
4798
|
/**
|
|
4795
|
-
* ID for the
|
|
4799
|
+
* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
4796
4800
|
*/
|
|
4797
4801
|
ModelKmsKeyId?: KmsKeyId;
|
|
4798
4802
|
/**
|
|
@@ -4839,7 +4843,7 @@ declare namespace Comprehend {
|
|
|
4839
4843
|
*/
|
|
4840
4844
|
ActiveModelArn?: ComprehendModelArn;
|
|
4841
4845
|
/**
|
|
4842
|
-
* The Amazon Resource Name (ARN) of the
|
|
4846
|
+
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
|
|
4843
4847
|
*/
|
|
4844
4848
|
DataAccessRoleArn?: IamRoleArn;
|
|
4845
4849
|
/**
|
|
@@ -4860,7 +4864,7 @@ declare namespace Comprehend {
|
|
|
4860
4864
|
*/
|
|
4861
4865
|
SecurityGroupIds: SecurityGroupIds;
|
|
4862
4866
|
/**
|
|
4863
|
-
* The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s
|
|
4867
|
+
* The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
|
|
4864
4868
|
*/
|
|
4865
4869
|
Subnets: Subnets;
|
|
4866
4870
|
}
|