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
Title | ID | Type | Data Type | Description |
---|
| _key | core | string | |
| account_id | core | string | |
| data_access_role_arn | core | string | The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. |
| document_classifier_arn | core | string | The Amazon Resource Name (ARN) that identifies the document classifier. |
| end_time | core | timestamp | The time that the document classification job completed. |
| flywheel_arn | core | string | The Amazon Resource Number (ARN) of the flywheel |
| input_data_config | core | json | The input data configuration that you supplied when you created the document classification job. |
| job_arn | core | 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:<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_id | core | string | The identifier assigned to the document classification job. |
| job_name | core | string | The name that you assigned to the document classification job. |
| job_status | core | string | The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure. |
| message | core | string | A description of the status of the job. |
| output_data_config | core | json | The output data configuration that you supplied when you created the document classification job. |
| submit_time | core | timestamp | The time that the document classification job was submitted for processing. |
| tags | core | hstore | |
| volume_kms_key_id | core | 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" |
| vpc_config | core | json | 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. |