class Aws::Comprehend::Types::TopicsDetectionJobProperties

Provides information about a topic detection job.

@!attribute [rw] job_id

The identifier assigned to the topic detection job.
@return [String]

@!attribute [rw] job_arn

The Amazon Resource Name (ARN) of the topics detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, 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`
@return [String]

@!attribute [rw] job_name

The name of the topic detection job.
@return [String]

@!attribute [rw] job_status

The current status of the topic detection job. If the status is
`Failed`, the reason for the failure is shown in the `Message`
field.
@return [String]

@!attribute [rw] message

A description for the status of a job.
@return [String]

@!attribute [rw] submit_time

The time that the topic detection job was submitted for processing.
@return [Time]

@!attribute [rw] end_time

The time that the topic detection job was completed.
@return [Time]

@!attribute [rw] input_data_config

The input data configuration supplied when you created the topic
detection job.
@return [Types::InputDataConfig]

@!attribute [rw] output_data_config

The output data configuration supplied when you created the topic
detection job.
@return [Types::OutputDataConfig]

@!attribute [rw] number_of_topics

The number of topics to detect supplied when you created the topic
detection job. The default is 10.
@return [Integer]

@!attribute [rw] data_access_role_arn

The Amazon Resource Name (ARN) of the AWS Identity and Management
(IAM) role that grants Amazon Comprehend read access to your job
data.
@return [String]

@!attribute [rw] volume_kms_key_id

ID for the AWS 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"`
@return [String]

@!attribute [rw] vpc_config

Configuration 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][1].

[1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
@return [Types::VpcConfig]

@see docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TopicsDetectionJobProperties AWS API Documentation

Constants

SENSITIVE