Interface StartDocumentClassificationJobCommandOutput

The output of StartDocumentClassificationJobCommand.

interface StartDocumentClassificationJobCommandOutput {
    $metadata: ResponseMetadata;
    DocumentClassifierArn?: string;
    JobArn?: string;
    JobId?: string;
    JobStatus?: JobStatus;
}

Hierarchy (view full)

Properties

$metadata DocumentClassifierArn? JobArn? JobId? JobStatus?

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional DocumentClassifierArn

DocumentClassifierArn?: string

The ARN of the custom classification model.

Optional JobArn

JobArn?: string

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::comprehend:::document-classification-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Optional JobId

JobId?: string

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

Optional JobStatus

JobStatus?: JobStatus

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.

Settings

Member Visibility

Theme

On This Page