Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1484423422.2 KB

Starts an asynchronous event detection job for a collection of documents.

post/#X-Amz-Target=Comprehend_20171127.StartEventsDetectionJob

Headers

X-Amz-Target'Comprehend_20171127.StartEventsDetectionJob' required

Request body

DataAccessRoleArnstring required

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

JobNamestring

The identifier of the events detection job.

LanguageCode'en' | 'es' | 'fr' | 'de' | 'it' | 'pt' | 'ar' | 'hi' | 'ja' | 'ko' | 'zh' | 'zh-TW' required

The language code of the input documents.

ClientRequestTokenstring

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

TargetEventTypesEventTypeString[] required

The types of events to detect in the input documents.

Response

Success

JobIdstring

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

JobArnstring
<p>The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:</p> <p> <code>arn:&lt;partition&gt;:comprehend:&lt;region&gt;:&lt;account-id&gt;:events-detection-job/&lt;job-id&gt;</code> </p> <p>The following is an example job ARN:</p> <p> <code>arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab</code> </p>
JobStatus'SUBMITTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'STOP_REQUESTED' | 'STOPPED'

The status of the events detection job.