EventsDetectionJobProperties

Provides information about an events detection job.

DataAccessRoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Required: No

EndTime

The time that the events detection job completed.

Type: Timestamp

Required: No

InputDataConfig

The input data configuration that you supplied when you created the events detection job.

Type: InputDataConfig object

Required: No

JobArn

The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, AWS Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?

Required: No

JobId

The identifier assigned to the events detection job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: No

JobName

The name you assigned the events detection job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: No

JobStatus

The current status of the events detection job.

Type: String

Required: No

LanguageCode

The language code of the input documents.

Type: String

Valid Values: en

Required: No

Message

A description of the status of the events detection job.

Type: String

Required: No

OutputDataConfig

The output data configuration that you supplied when you created the events detection job.

Type: OutputDataConfig object

Required: No

SubmitTime

The time that the events detection job was submitted for processing.

Type: Timestamp

Required: No

TargetEventTypes

The types of events that are detected by the job.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [A-Z_]*

Required: No

EventsDetectionJobProperties

Contents

See Also