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

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

Overview

Provides information about an events detection job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arnString

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

Returns:

  • (String)


3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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_timeTime

The time that the events detection job completed.

Returns:

  • (Time)


3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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_configTypes::InputDataConfig

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



3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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_arnString

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


3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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_idString

The identifier assigned to the events detection job.

Returns:

  • (String)


3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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_nameString

The name you assigned the events detection job.

Returns:

  • (String)


3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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_statusString

The current status of the events detection job.

Returns:

  • (String)


3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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_codeString

The language code of the input documents.

Returns:

  • (String)


3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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

#messageString

A description of the status of the events detection job.

Returns:

  • (String)


3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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_configTypes::OutputDataConfig

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



3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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_timeTime

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

Returns:

  • (Time)


3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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_typesArray<String>

The types of events that are detected by the job.

Returns:

  • (Array<String>)


3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3633

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