Interface EventsDetectionJobProperties

Provides information about an events detection job.

interface EventsDetectionJobProperties {
    DataAccessRoleArn?: string;
    EndTime?: Date;
    InputDataConfig?: InputDataConfig;
    JobArn?: string;
    JobId?: string;
    JobName?: string;
    JobStatus?: JobStatus;
    LanguageCode?: LanguageCode;
    Message?: string;
    OutputDataConfig?: OutputDataConfig;
    SubmitTime?: Date;
    TargetEventTypes?: string[];
}

Properties

DataAccessRoleArn? EndTime? InputDataConfig? JobArn? JobId? JobName? JobStatus? LanguageCode? Message? OutputDataConfig? SubmitTime? TargetEventTypes?

Properties

Optional DataAccessRoleArn

DataAccessRoleArn?: string

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

Optional EndTime

EndTime?: Date

The time that the events detection job completed.

Optional InputDataConfig

InputDataConfig?: InputDataConfig

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

Optional JobArn

JobArn?: string

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:

arn::comprehend:::events-detection-job/

The following is an example job ARN:

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

Optional JobId

JobId?: string

The identifier assigned to the events detection job.

Optional JobName

JobName?: string

The name you assigned the events detection job.

Optional JobStatus

JobStatus?: JobStatus

The current status of the events detection job.

Optional LanguageCode

LanguageCode?: LanguageCode

The language code of the input documents.

Optional Message

Message?: string

A description of the status of the events detection job.

Optional OutputDataConfig

OutputDataConfig?: OutputDataConfig

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

Optional SubmitTime

SubmitTime?: Date

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

Optional TargetEventTypes

TargetEventTypes?: string[]

The types of events that are detected by the job.

Settings

Member Visibility

Theme

On This Page