Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1484423422.2 KB

Starts an asynchronous document classification job. Use the <code>DescribeDocumentClassificationJob</code> operation to track the progress of the job.

post/#X-Amz-Target=Comprehend_20171127.StartDocumentClassificationJob

Headers

X-Amz-Target'Comprehend_20171127.StartDocumentClassificationJob' required

Request body

JobNamestring

The identifier of the job.

DocumentClassifierArnstring

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

DataAccessRoleArnstring required

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

ClientRequestTokenstring

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

VolumeKmsKeyIdstring
<p>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:</p> <ul> <li> <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> </ul>
FlywheelArnstring

The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

Response

Success

JobIdstring

The identifier generated for the job. To get the status of the job, use this identifier with the <code>DescribeDocumentClassificationJob</code> operation.

JobArnstring
<p>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:</p> <p> <code>arn:&lt;partition&gt;:comprehend:&lt;region&gt;:&lt;account-id&gt;:document-classification-job/&lt;job-id&gt;</code> </p> <p>The following is an example job ARN:</p> <p> <code>arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab</code> </p>
JobStatus'SUBMITTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'STOP_REQUESTED' | 'STOPPED'
<p>The status of the job:</p> <ul> <li> <p>SUBMITTED - The job has been received and queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was successfully completed and the output is available.</p> </li> <li> <p>FAILED - The job did not complete. For details, use the <code>DescribeDocumentClassificationJob</code> operation.</p> </li> <li> <p>STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.</p> </li> <li> <p>STOPPED - The job was successfully stopped without completing.</p> </li> </ul>
DocumentClassifierArnstring

The ARN of the custom classification model.