|
299 | 299 | "shape": "InternalServerException" |
300 | 300 | } |
301 | 301 | ], |
302 | | - "documentation": "<p>Creates a model-specific endpoint for synchronous inference for a previously trained custom model </p>" |
| 302 | + "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>" |
303 | 303 | }, |
304 | 304 | "CreateEntityRecognizer": { |
305 | 305 | "name": "CreateEntityRecognizer", |
|
404 | 404 | "shape": "InternalServerException" |
405 | 405 | } |
406 | 406 | ], |
407 | | - "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>" |
| 407 | + "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>" |
408 | 408 | }, |
409 | 409 | "DeleteEntityRecognizer": { |
410 | 410 | "name": "DeleteEntityRecognizer", |
|
575 | 575 | "shape": "InternalServerException" |
576 | 576 | } |
577 | 577 | ], |
578 | | - "documentation": "<p>Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint.</p>" |
| 578 | + "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>" |
579 | 579 | }, |
580 | 580 | "DescribeEntitiesDetectionJob": { |
581 | 581 | "name": "DescribeEntitiesDetectionJob", |
|
1169 | 1169 | "shape": "InternalServerException" |
1170 | 1170 | } |
1171 | 1171 | ], |
1172 | | - "documentation": "<p>Gets a list of all existing endpoints that you've created.</p>" |
| 1172 | + "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>" |
1173 | 1173 | }, |
1174 | 1174 | "ListEntitiesDetectionJobs": { |
1175 | 1175 | "name": "ListEntitiesDetectionJobs", |
|
1909 | 1909 | "shape": "InternalServerException" |
1910 | 1910 | } |
1911 | 1911 | ], |
1912 | | - "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>" |
| 1912 | + "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>" |
1913 | 1913 | }, |
1914 | 1914 | "StopTargetedSentimentDetectionJob": { |
1915 | 1915 | "name": "StopTargetedSentimentDetectionJob", |
|
1934 | 1934 | "shape": "InternalServerException" |
1935 | 1935 | } |
1936 | 1936 | ], |
1937 | | - "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>" |
| 1937 | + "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>" |
1938 | 1938 | }, |
1939 | 1939 | "StopTrainingDocumentClassifier": { |
1940 | 1940 | "name": "StopTrainingDocumentClassifier", |
|
2089 | 2089 | "shape": "InternalServerException" |
2090 | 2090 | } |
2091 | 2091 | ], |
2092 | | - "documentation": "<p>Updates information about the specified endpoint.</p>" |
| 2092 | + "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>" |
2093 | 2093 | } |
2094 | 2094 | }, |
2095 | 2095 | "shapes": { |
|
2265 | 2265 | "members": { |
2266 | 2266 | "TextList": { |
2267 | 2267 | "shape": "CustomerInputStringList", |
2268 | | - "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>" |
| 2268 | + "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>" |
2269 | 2269 | }, |
2270 | 2270 | "LanguageCode": { |
2271 | 2271 | "shape": "LanguageCode", |
|
2491 | 2491 | }, |
2492 | 2492 | "EndpointArn": { |
2493 | 2493 | "shape": "DocumentClassifierEndpointArn", |
2494 | | - "documentation": "<p>The Amazon Resource Number (ARN) of the endpoint.</p>" |
| 2494 | + "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>" |
2495 | 2495 | } |
2496 | 2496 | } |
2497 | 2497 | }, |
|
2553 | 2553 | }, |
2554 | 2554 | "LanguageCode": { |
2555 | 2555 | "shape": "LanguageCode", |
2556 | | - "documentation": "<p>The language of the input documents.</p>" |
| 2556 | + "documentation": "<p>The language of the input documents. Currently, English is the only valid language.</p>" |
2557 | 2557 | } |
2558 | 2558 | } |
2559 | 2559 | }, |
|
2758 | 2758 | "member": { |
2759 | 2759 | "shape": "CustomerInputString" |
2760 | 2760 | }, |
| 2761 | + "min": 1, |
2761 | 2762 | "sensitive": true |
2762 | 2763 | }, |
2763 | 2764 | "DeleteDocumentClassifierRequest": { |
|
3150 | 3151 | }, |
3151 | 3152 | "EndpointArn": { |
3152 | 3153 | "shape": "EntityRecognizerEndpointArn", |
3153 | | - "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>" |
| 3154 | + "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>" |
3154 | 3155 | } |
3155 | 3156 | } |
3156 | 3157 | }, |
|
3204 | 3205 | }, |
3205 | 3206 | "LanguageCode": { |
3206 | 3207 | "shape": "LanguageCode", |
3207 | | - "documentation": "<p>The language of the input documents.</p>" |
| 3208 | + "documentation": "<p>The language of the input documents. Currently, English is the only valid language.</p>" |
3208 | 3209 | } |
3209 | 3210 | } |
3210 | 3211 | }, |
|
3364 | 3365 | }, |
3365 | 3366 | "VpcConfig": { |
3366 | 3367 | "shape": "VpcConfig", |
3367 | | - "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>" |
| 3368 | + "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>" |
3368 | 3369 | } |
3369 | 3370 | }, |
3370 | 3371 | "documentation": "<p>Provides information about a document classification job.</p>" |
|
3444 | 3445 | "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>" |
3445 | 3446 | } |
3446 | 3447 | }, |
3447 | | - "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>" |
| 3448 | + "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>" |
3448 | 3449 | }, |
3449 | 3450 | "DocumentClassifierMode": { |
3450 | 3451 | "type": "string", |
|
3524 | 3525 | }, |
3525 | 3526 | "VpcConfig": { |
3526 | 3527 | "shape": "VpcConfig", |
3527 | | - "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>" |
| 3528 | + "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>" |
3528 | 3529 | }, |
3529 | 3530 | "Mode": { |
3530 | 3531 | "shape": "DocumentClassifierMode", |
|
3809 | 3810 | "documentation": "<p>Data access role ARN to use in case the new model is encrypted with a customer KMS key.</p>" |
3810 | 3811 | } |
3811 | 3812 | }, |
3812 | | - "documentation": "<p>Specifies information about the specified endpoint.</p>" |
| 3813 | + "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>" |
3813 | 3814 | }, |
3814 | 3815 | "EndpointPropertiesList": { |
3815 | 3816 | "type": "list", |
|
5405 | 5406 | "AWS_SECRET_KEY", |
5406 | 5407 | "IP_ADDRESS", |
5407 | 5408 | "MAC_ADDRESS", |
5408 | | - "ALL" |
| 5409 | + "ALL", |
| 5410 | + "LICENSE_PLATE", |
| 5411 | + "VEHICLE_IDENTIFICATION_NUMBER", |
| 5412 | + "UK_NATIONAL_INSURANCE_NUMBER", |
| 5413 | + "CA_SOCIAL_INSURANCE_NUMBER", |
| 5414 | + "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", |
| 5415 | + "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", |
| 5416 | + "IN_PERMANENT_ACCOUNT_NUMBER", |
| 5417 | + "IN_NREGA", |
| 5418 | + "INTERNATIONAL_BANK_ACCOUNT_NUMBER", |
| 5419 | + "SWIFT_CODE", |
| 5420 | + "UK_NATIONAL_HEALTH_SERVICE_NUMBER", |
| 5421 | + "CA_HEALTH_NUMBER", |
| 5422 | + "IN_AADHAAR", |
| 5423 | + "IN_VOTER_NUMBER" |
5409 | 5424 | ] |
5410 | 5425 | }, |
5411 | 5426 | "PiiOutputDataConfig": { |
|
5984 | 5999 | }, |
5985 | 6000 | "LanguageCode": { |
5986 | 6001 | "shape": "LanguageCode", |
5987 | | - "documentation": "<p>The language of the input documents.</p>" |
| 6002 | + "documentation": "<p>The language of the input documents. Currently, English is the only valid language.</p>" |
5988 | 6003 | }, |
5989 | 6004 | "ClientRequestToken": { |
5990 | 6005 | "shape": "ClientRequestTokenString", |
|
6105 | 6120 | }, |
6106 | 6121 | "LanguageCode": { |
6107 | 6122 | "shape": "LanguageCode", |
6108 | | - "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>" |
| 6123 | + "documentation": "<p>The language of the input documents. Currently, English is the only valid language.</p>" |
6109 | 6124 | }, |
6110 | 6125 | "ClientRequestToken": { |
6111 | 6126 | "shape": "ClientRequestTokenString", |
|
0 commit comments