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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Provides information about a topic detection job.

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

The time that the topic detection job was completed.

Returns:

  • (Time)


2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2198

class TopicsDetectionJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :number_of_topics)
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

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



2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2198

class TopicsDetectionJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :number_of_topics)
  include Aws::Structure
end

#job_idString

The identifier assigned to the topic detection job.

Returns:

  • (String)


2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2198

class TopicsDetectionJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :number_of_topics)
  include Aws::Structure
end

#job_nameString

The name of the topic detection job.

Returns:

  • (String)


2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2198

class TopicsDetectionJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :number_of_topics)
  include Aws::Structure
end

#job_statusString

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Returns:

  • (String)


2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2198

class TopicsDetectionJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :number_of_topics)
  include Aws::Structure
end

#messageString

A description for the status of a job.

Returns:

  • (String)


2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2198

class TopicsDetectionJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :number_of_topics)
  include Aws::Structure
end

#number_of_topicsInteger

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

Returns:

  • (Integer)


2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2198

class TopicsDetectionJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :number_of_topics)
  include Aws::Structure
end

#output_data_configTypes::OutputDataConfig

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



2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2198

class TopicsDetectionJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :number_of_topics)
  include Aws::Structure
end

#submit_timeTime

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

Returns:

  • (Time)


2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2198

class TopicsDetectionJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :number_of_topics)
  include Aws::Structure
end