Class: Aws::Comprehend::Types::StartEventsDetectionJobRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7182

class StartEventsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :client_request_token,
  :target_event_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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


7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7182

class StartEventsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :client_request_token,
  :target_event_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_config ⇒ Types::InputDataConfig

Specifies the format and location of the input data for the job.

Returns:



7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7182

class StartEventsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :client_request_token,
  :target_event_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The identifier of the events detection job.

Returns:

  • (String) 


7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7182

class StartEventsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :client_request_token,
  :target_event_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The language code of the input documents.

Returns:

  • (String) 


7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7182

class StartEventsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :client_request_token,
  :target_event_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ Types::OutputDataConfig

Specifies where to send the output files.

Returns:



7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7182

class StartEventsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :client_request_token,
  :target_event_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:



7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7182

class StartEventsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :client_request_token,
  :target_event_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#target_event_types ⇒ Array<String>

The types of events to detect in the input documents.

Returns:

  • (Array<String>) 


7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7182

class StartEventsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :client_request_token,
  :target_event_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end