Class: Aws::Comprehend::Types::EventsDetectionJobProperties

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::EventsDetectionJobProperties

Defined in:

gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Provides information about an events detection job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_access_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

• #end_time ⇒ Time

  The time that the events detection job completed.

• #input_data_config ⇒ Types::InputDataConfig

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

• #job_arn ⇒ String

  The Amazon Resource Name (ARN) of the events detection job.

• #job_id ⇒ String

  The identifier assigned to the events detection job.

• #job_name ⇒ String

  The name you assigned the events detection job.

• #job_status ⇒ String

  The current status of the events detection job.

• #language_code ⇒ String

  The language code of the input documents.

• #message ⇒ String

  A description of the status of the events detection job.

• #output_data_config ⇒ Types::OutputDataConfig

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

• #submit_time ⇒ Time

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

• #target_event_types ⇒ Array<String>

  The types of events that are detected by the job.

Instance Attribute Details

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The time that the events detection job completed.

Returns:

• (Time)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_config ⇒ Types::InputDataConfig

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

Returns:

• (Types::InputDataConfig)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#job_arn ⇒ String

The Amazon Resource Name (ARN) of the events 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>:events-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The identifier assigned to the events detection job.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The name you assigned the events detection job.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#job_status ⇒ String

The current status of the events detection job.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The language code of the input documents.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

A description of the status of the events detection job.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ Types::OutputDataConfig

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

Returns:

• (Types::OutputDataConfig)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#submit_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end

#target_event_types ⇒ Array<String>

The types of events that are detected by the job.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4637

class EventsDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :target_event_types)
  SENSITIVE = []
  include Aws::Structure
end