Comprehend Topics Detection Job Properties

Comprehend Topics Detection Job Properties in AWS describe the details of a topic modeling job run by Amazon Comprehend. It includes information such as the job name, job status, input and output data configuration, number of topics detected, and timestamps for creation and completion. This resource helps track and manage topic detection jobs that analyze large text datasets to automatically group documents into coherent topics.

aws.comprehend_topics_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 job data.
end_timecoretimestampThe time that the topic detection job was completed.
input_data_configcorejsonThe input data configuration supplied when you created the topic detection job.
job_arncorestringThe Amazon Resource Name (ARN) of the topics 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>:topics-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
job_idcorestringThe identifier assigned to the topic detection job.
job_namecorestringThe name of the topic detection job.
job_statuscorestringThe current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
messagecorestringA description for the status of a job.
number_of_topicscoreint64The number of topics to detect supplied when you created the topic detection job. The default is 10.
output_data_configcorejsonThe output data configuration supplied when you created the topic detection job.
submit_timecoretimestampThe time that the topic 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 topic detection job. For more information, see Amazon VPC.