Skip to content

StartEventsDetectionJob

Source: src/AWS/Comprehend/StartEventsDetectionJob.ts

Runtime binding for comprehend:StartEventsDetectionJob — start an asynchronous event detection job over a collection of documents in S3.

The binding is constructed with the data-access role (the IAM role Amazon Comprehend assumes to read the input documents and write results; its trust policy must allow comprehend.amazonaws.com). The role’s ARN is injected as DataAccessRoleArn on every runtime request and the host is granted iam:PassRole on it alongside the comprehend:StartEventsDetectionJob action (which has no resource-level IAM). Track the job with DescribeEventsDetectionJob and stop it with StopEventsDetectionJob.

// deploy time — bind the Comprehend data-access role
const startEventsDetectionJob = yield* AWS.Comprehend.StartEventsDetectionJob(dataAccessRole);
// runtime
const job = yield* startEventsDetectionJob({
TargetEventTypes: ["BANKRUPTCY", "EMPLOYMENT"],
InputDataConfig: { S3Uri: "s3://my-bucket/input/", InputFormat: "ONE_DOC_PER_LINE" },
OutputDataConfig: { S3Uri: "s3://my-bucket/output/" },
LanguageCode: "en",
});
// job.JobId, job.JobStatus === "SUBMITTED"