Comprehend Document Classification Job Properties

Comprehend Document Classification Job Properties in AWS describe the details of a document classification job run by Amazon Comprehend. It includes information such as the job ID, job name, job status, input and output data configuration, the classifier used, and timestamps for creation and completion. This resource helps track and manage classification jobs that automatically categorize documents based on custom or pre-trained models.

aws.comprehend_document_classification_job

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
data_access_role_arncorestringThe Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
document_classifier_arncorestringThe Amazon Resource Name (ARN) that identifies the document classifier.
end_timecoretimestampThe time that the document classification job completed.
flywheel_arncorestringThe Amazon Resource Number (ARN) of the flywheel
input_data_configcorejsonThe input data configuration that you supplied when you created the document classification job.
job_arncorestringThe 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
job_idcorestringThe identifier assigned to the document classification job.
job_namecorestringThe name that you assigned to the document classification job.
job_statuscorestringThe current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
messagecorestringA description of the status of the job.
output_data_configcorejsonThe output data configuration that you supplied when you created the document classification job.
submit_timecoretimestampThe time that the document classification job was submitted for processing.
tagscorehstore
volume_kms_key_idcorestringID 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"
vpc_configcorejsonConfiguration 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.