Documentation

Provides information about a document classification job.

See: newDocumentClassificationJobProperties smart constructor.

Create a value of DocumentClassificationJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DocumentClassificationJobProperties', documentClassificationJobProperties_jobId - The identifier assigned to the document classification job.

$sel:jobArn:DocumentClassificationJobProperties', documentClassificationJobProperties_jobArn - The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

$sel:documentClassifierArn:DocumentClassificationJobProperties', documentClassificationJobProperties_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.

$sel:jobName:DocumentClassificationJobProperties', documentClassificationJobProperties_jobName - The name that you assigned to the document classification job.

$sel:inputDataConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_inputDataConfig - The input data configuration that you supplied when you created the document classification job.

$sel:vpcConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_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.

$sel:volumeKmsKeyId:DocumentClassificationJobProperties', documentClassificationJobProperties_volumeKmsKeyId - ID for the AWS 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"

$sel:endTime:DocumentClassificationJobProperties', documentClassificationJobProperties_endTime - The time that the document classification job completed.

$sel:outputDataConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_outputDataConfig - The output data configuration that you supplied when you created the document classification job.

$sel:dataAccessRoleArn:DocumentClassificationJobProperties', documentClassificationJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:jobStatus:DocumentClassificationJobProperties', documentClassificationJobProperties_jobStatus - The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

$sel:message:DocumentClassificationJobProperties', documentClassificationJobProperties_message - A description of the status of the job.

$sel:submitTime:DocumentClassificationJobProperties', documentClassificationJobProperties_submitTime - The time that the document classification job was submitted for processing.

The identifier assigned to the document classification job.

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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 Amazon Resource Name (ARN) that identifies the document classifier.

The name that you assigned to the document classification job.

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

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.

ID for the AWS 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"

The time that the document classification job completed.

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

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

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

A description of the status of the job.

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