Interface DocumentClassificationJobProperties

Provides information about a document classification job.

interface DocumentClassificationJobProperties {
    DataAccessRoleArn?: string;
    DocumentClassifierArn?: string;
    EndTime?: Date;
    FlywheelArn?: string;
    InputDataConfig?: InputDataConfig;
    JobArn?: string;
    JobId?: string;
    JobName?: string;
    JobStatus?: JobStatus;
    Message?: string;
    OutputDataConfig?: OutputDataConfig;
    SubmitTime?: Date;
    VolumeKmsKeyId?: string;
    VpcConfig?: VpcConfig;
}

Properties

DataAccessRoleArn? DocumentClassifierArn? EndTime? FlywheelArn? InputDataConfig? JobArn? JobId? JobName? JobStatus? Message? OutputDataConfig? SubmitTime? VolumeKmsKeyId? VpcConfig?

Properties

Optional DataAccessRoleArn

DataAccessRoleArn?: string

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

Optional DocumentClassifierArn

DocumentClassifierArn?: string

The Amazon Resource Name (ARN) that identifies the document classifier.

Optional EndTime

EndTime?: Date

The time that the document classification job completed.

Optional FlywheelArn

FlywheelArn?: string

The Amazon Resource Number (ARN) of the flywheel

Optional InputDataConfig

InputDataConfig?: InputDataConfig

The input data configuration that you supplied when you created the document classification job.

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 assigned to the document classification job.

Optional JobName

JobName?: string

The name that you assigned to the document classification job.

Optional JobStatus

JobStatus?: JobStatus

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

Optional Message

Message?: string

A description of the status of the job.

Optional OutputDataConfig

OutputDataConfig?: OutputDataConfig

The output data configuration that you supplied when you created the document classification job.

Optional SubmitTime

SubmitTime?: Date

The time that the document classification job was submitted for processing.

Optional VolumeKmsKeyId

VolumeKmsKeyId?: string

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:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Optional VpcConfig

VpcConfig?: VpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

Settings

Member Visibility

Theme

On This Page