Class: Aws::Comprehend::Types::StartEventsDetectionJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::StartEventsDetectionJobRequest
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
When making an API call, you may pass StartEventsDetectionJobRequest data as a hash:
{
input_data_config: { # required
s3_uri: "S3Uri", # required
input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
document_reader_config: {
document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
feature_types: ["TABLES"], # accepts TABLES, FORMS
},
},
output_data_config: { # required
s3_uri: "S3Uri", # required
kms_key_id: "KmsKeyId",
},
data_access_role_arn: "IamRoleArn", # required
job_name: "JobName",
language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
client_request_token: "ClientRequestTokenString",
target_event_types: ["EventTypeString"], # required
tags: [
{
key: "TagKey", # required
value: "TagValue",
},
],
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
An unique identifier for the request.
-
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
-
#input_data_config ⇒ Types::InputDataConfig
Specifies the format and location of the input data for the job.
-
#job_name ⇒ String
The identifier of the events detection job.
-
#language_code ⇒ String
The language code of the input documents.
-
#output_data_config ⇒ Types::OutputDataConfig
Specifies where to send the output files.
-
#tags ⇒ Array<Types::Tag>
Tags to be associated with the events detection job.
-
#target_event_types ⇒ Array<String>
The types of events to detect in the input documents.
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.
6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6203 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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6203 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.
6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6203 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.
6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6203 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.
6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6203 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.
6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6203 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 be associated 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.
6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6203 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.
6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6203 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 |