topics_detection_jobs

Creates, updates, deletes, gets or lists a topics_detection_jobs resource.

Overview

Name	topics_detection_jobs
Type	Resource
Id	aws.comprehend.topics_detection_jobs

Fields

The following fields are returned by SELECT queries:

describe_topics_detection_job

Name	Datatype	Description
data_access_role_arn	string	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
end_time	string (date-time)	The time that the topic detection job was completed.
input_data_config	object	The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.
job_arn	string	The 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 (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-[a-zA-Z0-9])((/dataset/[a-zA-Z0-9](-[a-zA-Z0-9]))|(/version/[a-zA-Z0-9](-[a-zA-Z0-9])*))?</code>)
job_id	string	The identifier assigned to the topic detection job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_name	string	The name of the topic detection job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_status	string	The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field. (SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED)
message	string	A description for the status of a job.
number_of_topics	integer	The number of topics to detect supplied when you created the topic detection job. The default is 10.
output_data_config	object	Provides configuration parameters for the output of inference jobs.
submit_time	string (date-time)	The time that the topic detection job was submitted for processing.
volume_kms_key_id	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" (pattern: <code>^\p{ASCII}+$</code>)
vpc_config	object	Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

list_topics_detection_jobs

Name	Datatype	Description
data_access_role_arn	string	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
end_time	string (date-time)	The time that the topic detection job was completed.
input_data_config	object	The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.
job_arn	string	The 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 (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-[a-zA-Z0-9])((/dataset/[a-zA-Z0-9](-[a-zA-Z0-9]))|(/version/[a-zA-Z0-9](-[a-zA-Z0-9])*))?</code>)
job_id	string	The identifier assigned to the topic detection job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_name	string	The name of the topic detection job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_status	string	The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field. (SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED)
message	string	A description for the status of a job.
number_of_topics	integer	The number of topics to detect supplied when you created the topic detection job. The default is 10.
output_data_config	object	Provides configuration parameters for the output of inference jobs.
submit_time	string (date-time)	The time that the topic detection job was submitted for processing.
volume_kms_key_id	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" (pattern: <code>^\p{ASCII}+$</code>)
vpc_config	object	Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_topics_detection_job	select	region		Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
list_topics_detection_jobs	select	region		Gets a list of the topic detection jobs that you have submitted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_topics_detection_job

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

SELECT
data_access_role_arn,
end_time,
input_data_config,
job_arn,
job_id,
job_name,
job_status,
message,
number_of_topics,
output_data_config,
submit_time,
volume_kms_key_id,
vpc_config
FROM aws.comprehend.topics_detection_jobs
WHERE region = '{{ region }}' -- required
;

list_topics_detection_jobs

Gets a list of the topic detection jobs that you have submitted.

SELECT
data_access_role_arn,
end_time,
input_data_config,
job_arn,
job_id,
job_name,
job_status,
message,
number_of_topics,
output_data_config,
submit_time,
volume_kms_key_id,
vpc_config
FROM aws.comprehend.topics_detection_jobs
WHERE region = '{{ region }}' -- required
;