Comprehend Key Phrases Detection Job Properties

Docs > DDSQL Reference > Data Directory > Comprehend Key Phrases Detection Job Properties

Comprehend Key Phrases Detection Job Properties in AWS describe the details of a key phrases detection job run by Amazon Comprehend. It includes information such as the job ID, job status, input and output data configuration, language code, and timestamps. This resource helps track and manage asynchronous text analysis jobs that identify key phrases in large text datasets.

aws.comprehend_key_phrases_detection_job

Fields

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.
end_time	core	timestamp	The time that the key phrases detection job completed.
input_data_config	core	json	The input data configuration that you supplied when you created the key phrases detection job.
job_arn	core	string	The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
job_id	core	string	The identifier assigned to the key phrases detection job.
job_name	core	string	The name that you assigned the key phrases detection job.
job_status	core	string	The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
language_code	core	string	The language code of the input documents.
message	core	string	A description of the status of a job.
output_data_config	core	json	The output data configuration that you supplied when you created the key phrases detection job.
submit_time	core	timestamp	The time that the key phrases detection job was submitted for processing.
tags	core	hstore
volume_kms_key_id	core	string	ID for the 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 key phrases detection job. For more information, see Amazon VPC.