{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-start-document-classification-job-response-structure.json",
"name": "StartDocumentClassificationJobResponse",
"description": "StartDocumentClassificationJobResponse schema",
"type": "object",
"properties": {
"JobId": {
"allOf": [
{
"$ref": "#/components/schemas/JobId"
},
{
"description": "The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation."
}
]
},
"JobArn": {
"allOf": [
{
"$ref": "#/components/schemas/ComprehendArn"
},
{
"description": "
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
The status of the job:
SUBMITTED - The job has been received and queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.