You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Comprehend::Types::TopicsDetectionJobProperties

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides information about a topic detection job.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arn ⇒ String

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

Returns:

  • (String) —

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

#end_time ⇒ Time

The time that the topic detection job was completed.

Returns:

  • (Time) —

    The time that the topic detection job was completed.

#input_data_config ⇒ Types::InputDataConfig

The input data configuration supplied when you created the topic detection job.

Returns:

  • (Types::InputDataConfig) —

    The input data configuration supplied when you created the topic detection job.

#job_id ⇒ String

The identifier assigned to the topic detection job.

Returns:

  • (String) —

    The identifier assigned to the topic detection job.

#job_name ⇒ String

The name of the topic detection job.

Returns:

  • (String) —

    The name of the topic detection job.

#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.

Possible values:

  • SUBMITTED
  • IN_PROGRESS
  • COMPLETED
  • FAILED
  • STOP_REQUESTED
  • STOPPED

Returns:

  • (String) —

    The current status of the topic detection job.

#message ⇒ String

A description for the status of a job.

Returns:

  • (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.

Returns:

  • (Integer) —

    The number of topics to detect supplied when you created the topic detection job.

#output_data_config ⇒ Types::OutputDataConfig

The output data configuration supplied when you created the topic detection job.

Returns:

#submit_time ⇒ Time

The time that the topic detection job was submitted for processing.

Returns:

  • (Time) —

    The time that the topic detection job was submitted for processing.

#volume_kms_key_id ⇒ String

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"

Returns:

  • (String) —

    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.

#vpc_config ⇒ Types::VpcConfig

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.

Returns:

  • (Types::VpcConfig) —

    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.