Comprehend Entities Detection Job Properties

Comprehend Entities Detection Job Properties in AWS describe the details of an entity detection job run by Amazon Comprehend. It includes information such as the job ID, job status, input and output data configuration, language code, job name, and timestamps. This resource helps track and manage large-scale text analysis tasks where Comprehend identifies entities like people, places, organizations, and other categories within documents.

aws.comprehend_entities_detection_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.
end_timecoretimestampThe time that the entities detection job completed
entity_recognizer_arncorestringThe Amazon Resource Name (ARN) that identifies the entity recognizer.
flywheel_arncorestringThe Amazon Resource Name (ARN) of the flywheel associated with this job.
input_data_configcorejsonThe input data configuration that you supplied when you created the entities detection job.
job_arncorestringThe Amazon Resource Name (ARN) of the entities detection 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>:entities-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
job_idcorestringThe identifier assigned to the entities detection job.
job_namecorestringThe name that you assigned the entities detection job.
job_statuscorestringThe current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
language_codecorestringThe language code of the input documents.
messagecorestringA description of the status of a job.
output_data_configcorejsonThe output data configuration that you supplied when you created the entities detection job.
submit_timecoretimestampThe time that the entities detection 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 entity detection job. For more information, see Amazon VPC.