Start Events Detection Job
comprehend_start_events_detection_job | R Documentation |
Starts an asynchronous event detection job for a collection of documents¶
Description¶
Starts an asynchronous event detection job for a collection of documents.
Usage¶
comprehend_start_events_detection_job(InputDataConfig, OutputDataConfig,
DataAccessRoleArn, JobName, LanguageCode, ClientRequestToken,
TargetEventTypes, Tags)
Arguments¶
InputDataConfig
[required] Specifies the format and location of the input data for the job.
OutputDataConfig
[required] Specifies where to send the output files.
DataAccessRoleArn
[required] The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
JobName
The identifier of the events detection job.
LanguageCode
[required] The language code of the input documents.
ClientRequestToken
An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
TargetEventTypes
[required] The types of events to detect in the input documents.
Tags
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.
Value¶
A list with the following syntax:
list(
JobId = "string",
JobArn = "string",
JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"STOP_REQUESTED"|"STOPPED"
)
Request syntax¶
svc$start_events_detection_job(
InputDataConfig = list(
S3Uri = "string",
InputFormat = "ONE_DOC_PER_FILE"|"ONE_DOC_PER_LINE",
DocumentReaderConfig = list(
DocumentReadAction = "TEXTRACT_DETECT_DOCUMENT_TEXT"|"TEXTRACT_ANALYZE_DOCUMENT",
DocumentReadMode = "SERVICE_DEFAULT"|"FORCE_DOCUMENT_READ_ACTION",
FeatureTypes = list(
"TABLES"|"FORMS"
)
)
),
OutputDataConfig = list(
S3Uri = "string",
KmsKeyId = "string"
),
DataAccessRoleArn = "string",
JobName = "string",
LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|"ar"|"hi"|"ja"|"ko"|"zh"|"zh-TW",
ClientRequestToken = "string",
TargetEventTypes = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)