Skip to content

Commit ddbfd41

Browse files
author
AWS
committed
Amazon Comprehend Update: Comprehend releases 14 new entity types for DetectPiiEntities and ContainsPiiEntities APIs.
1 parent be46a4b commit ddbfd41

File tree

2 files changed

+40
-19
lines changed

2 files changed

+40
-19
lines changed

‎.changes/next-release/feature-AmazonComprehend-05d869b.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Comprehend",
4+
"contributor": "",
5+
"description": "Comprehend releases 14 new entity types for DetectPiiEntities and ContainsPiiEntities APIs."
6+
}

‎services/comprehend/src/main/resources/codegen-resources/service-2.json

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@
167167
{"shape":"TooManyTagsException"},
168168
{"shape":"InternalServerException"}
169169
],
170-
"documentation":"<p>Creates a model-specific endpoint for synchronous inference for a previously trained custom model </p>"
170+
"documentation":"<p>Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html\">Managing endpoints</a>.</p>"
171171
},
172172
"CreateEntityRecognizer":{
173173
"name":"CreateEntityRecognizer",
@@ -222,7 +222,7 @@
222222
{"shape":"TooManyRequestsException"},
223223
{"shape":"InternalServerException"}
224224
],
225-
"documentation":"<p>Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted.</p>"
225+
"documentation":"<p>Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html\">Managing endpoints</a>.</p>"
226226
},
227227
"DeleteEntityRecognizer":{
228228
"name":"DeleteEntityRecognizer",
@@ -319,7 +319,7 @@
319319
{"shape":"ResourceNotFoundException"},
320320
{"shape":"InternalServerException"}
321321
],
322-
"documentation":"<p>Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint.</p>"
322+
"documentation":"<p>Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html\">Managing endpoints</a>.</p>"
323323
},
324324
"DescribeEntitiesDetectionJob":{
325325
"name":"DescribeEntitiesDetectionJob",
@@ -657,7 +657,7 @@
657657
{"shape":"TooManyRequestsException"},
658658
{"shape":"InternalServerException"}
659659
],
660-
"documentation":"<p>Gets a list of all existing endpoints that you've created.</p>"
660+
"documentation":"<p>Gets a list of all existing endpoints that you've created. For information about endpoints, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html\">Managing endpoints</a>.</p>"
661661
},
662662
"ListEntitiesDetectionJobs":{
663663
"name":"ListEntitiesDetectionJobs",
@@ -1077,7 +1077,7 @@
10771077
{"shape":"JobNotFoundException"},
10781078
{"shape":"InternalServerException"}
10791079
],
1080-
"documentation":"<p>Stops a sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is be stopped and put into the <code>STOPPED</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </p> <p>When a job is stopped, any documents already processed are written to the output location.</p>"
1080+
"documentation":"<p>Stops a sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code>, the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is be stopped and put into the <code>STOPPED</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </p> <p>When a job is stopped, any documents already processed are written to the output location.</p>"
10811081
},
10821082
"StopTargetedSentimentDetectionJob":{
10831083
"name":"StopTargetedSentimentDetectionJob",
@@ -1092,7 +1092,7 @@
10921092
{"shape":"JobNotFoundException"},
10931093
{"shape":"InternalServerException"}
10941094
],
1095-
"documentation":"<p>Stops a targeted sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is be stopped and put into the <code>STOPPED</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </p> <p>When a job is stopped, any documents already processed are written to the output location.</p>"
1095+
"documentation":"<p>Stops a targeted sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code>, the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is be stopped and put into the <code>STOPPED</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </p> <p>When a job is stopped, any documents already processed are written to the output location.</p>"
10961096
},
10971097
"StopTrainingDocumentClassifier":{
10981098
"name":"StopTrainingDocumentClassifier",
@@ -1177,7 +1177,7 @@
11771177
{"shape":"ResourceUnavailableException"},
11781178
{"shape":"InternalServerException"}
11791179
],
1180-
"documentation":"<p>Updates information about the specified endpoint.</p>"
1180+
"documentation":"<p>Updates information about the specified endpoint. For information about endpoints, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html\">Managing endpoints</a>.</p>"
11811181
}
11821182
},
11831183
"shapes":{
@@ -1347,7 +1347,7 @@
13471347
"members":{
13481348
"TextList":{
13491349
"shape":"CustomerInputStringList",
1350-
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
1350+
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.</p>"
13511351
},
13521352
"LanguageCode":{
13531353
"shape":"LanguageCode",
@@ -1579,7 +1579,7 @@
15791579
},
15801580
"EndpointArn":{
15811581
"shape":"DocumentClassifierEndpointArn",
1582-
"documentation":"<p>The Amazon Resource Number (ARN) of the endpoint.</p>"
1582+
"documentation":"<p>The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html\">Managing endpoints</a>.</p>"
15831583
}
15841584
}
15851585
},
@@ -1649,7 +1649,7 @@
16491649
},
16501650
"LanguageCode":{
16511651
"shape":"LanguageCode",
1652-
"documentation":"<p>The language of the input documents.</p>"
1652+
"documentation":"<p>The language of the input documents. Currently, English is the only valid language.</p>"
16531653
}
16541654
}
16551655
},
@@ -1852,6 +1852,7 @@
18521852
"CustomerInputStringList":{
18531853
"type":"list",
18541854
"member":{"shape":"CustomerInputString"},
1855+
"min":1,
18551856
"sensitive":true
18561857
},
18571858
"DeleteDocumentClassifierRequest":{
@@ -2208,7 +2209,7 @@
22082209
},
22092210
"EndpointArn":{
22102211
"shape":"EntityRecognizerEndpointArn",
2211-
"documentation":"<p>The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.</p> <p>If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.</p>"
2212+
"documentation":"<p>The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.</p> <p>If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.</p> <p>For information about endpoints, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html\">Managing endpoints</a>.</p>"
22122213
}
22132214
}
22142215
},
@@ -2262,7 +2263,7 @@
22622263
},
22632264
"LanguageCode":{
22642265
"shape":"LanguageCode",
2265-
"documentation":"<p>The language of the input documents.</p>"
2266+
"documentation":"<p>The language of the input documents. Currently, English is the only valid language.</p>"
22662267
}
22672268
}
22682269
},
@@ -2422,7 +2423,7 @@
24222423
},
24232424
"VpcConfig":{
24242425
"shape":"VpcConfig",
2425-
"documentation":"<p> Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html\">Amazon VPC</a>. </p>"
2426+
"documentation":"<p> Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see <a href=\"https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html\">Amazon VPC</a>. </p>"
24262427
}
24272428
},
24282429
"documentation":"<p>Provides information about a document classification job.</p>"
@@ -2498,7 +2499,7 @@
24982499
"documentation":"<p>A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.</p> <p>This parameter is required if you set <code>DataFormat</code> to <code>AUGMENTED_MANIFEST</code>.</p>"
24992500
}
25002501
},
2501-
"documentation":"<p>The input properties for training a document classifier. </p> <p>For more information on how the input file is formatted, see <a>how-document-classification-training-data</a>. </p>"
2502+
"documentation":"<p>The input properties for training a document classifier. </p> <p>For more information on how the input file is formatted, see <a>prep-classifier-data</a>. </p>"
25022503
},
25032504
"DocumentClassifierMode":{
25042505
"type":"string",
@@ -2578,7 +2579,7 @@
25782579
},
25792580
"VpcConfig":{
25802581
"shape":"VpcConfig",
2581-
"documentation":"<p> Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html\">Amazon VPC</a>. </p>"
2582+
"documentation":"<p> Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see <a href=\"https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html\">Amazon VPC</a>. </p>"
25822583
},
25832584
"Mode":{
25842585
"shape":"DocumentClassifierMode",
@@ -2853,7 +2854,7 @@
28532854
"documentation":"<p>Data access role ARN to use in case the new model is encrypted with a customer KMS key.</p>"
28542855
}
28552856
},
2856-
"documentation":"<p>Specifies information about the specified endpoint.</p>"
2857+
"documentation":"<p>Specifies information about the specified endpoint. For information about endpoints, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html\">Managing endpoints</a>.</p>"
28572858
},
28582859
"EndpointPropertiesList":{
28592860
"type":"list",
@@ -4418,7 +4419,21 @@
44184419
"AWS_SECRET_KEY",
44194420
"IP_ADDRESS",
44204421
"MAC_ADDRESS",
4421-
"ALL"
4422+
"ALL",
4423+
"LICENSE_PLATE",
4424+
"VEHICLE_IDENTIFICATION_NUMBER",
4425+
"UK_NATIONAL_INSURANCE_NUMBER",
4426+
"CA_SOCIAL_INSURANCE_NUMBER",
4427+
"US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER",
4428+
"UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER",
4429+
"IN_PERMANENT_ACCOUNT_NUMBER",
4430+
"IN_NREGA",
4431+
"INTERNATIONAL_BANK_ACCOUNT_NUMBER",
4432+
"SWIFT_CODE",
4433+
"UK_NATIONAL_HEALTH_SERVICE_NUMBER",
4434+
"CA_HEALTH_NUMBER",
4435+
"IN_AADHAAR",
4436+
"IN_VOTER_NUMBER"
44224437
]
44234438
},
44244439
"PiiOutputDataConfig":{
@@ -5023,7 +5038,7 @@
50235038
},
50245039
"LanguageCode":{
50255040
"shape":"LanguageCode",
5026-
"documentation":"<p>The language of the input documents.</p>"
5041+
"documentation":"<p>The language of the input documents. Currently, English is the only valid language.</p>"
50275042
},
50285043
"ClientRequestToken":{
50295044
"shape":"ClientRequestTokenString",
@@ -5142,7 +5157,7 @@
51425157
},
51435158
"LanguageCode":{
51445159
"shape":"LanguageCode",
5145-
"documentation":"<p>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.</p>"
5160+
"documentation":"<p>The language of the input documents. Currently, English is the only valid language.</p>"
51465161
},
51475162
"ClientRequestToken":{
51485163
"shape":"ClientRequestTokenString",

0 commit comments

Comments
 (0)