Interface StartEventsDetectionJobRequest

interface StartEventsDetectionJobRequest {
    ClientRequestToken?: string;
    DataAccessRoleArn: undefined | string;
    InputDataConfig: undefined | InputDataConfig;
    JobName?: string;
    LanguageCode: undefined | LanguageCode;
    OutputDataConfig: undefined | OutputDataConfig;
    Tags?: Tag[];
    TargetEventTypes: undefined | string[];
}

Hierarchy (view full)

Properties

ClientRequestToken? DataAccessRoleArn InputDataConfig JobName? LanguageCode OutputDataConfig Tags? TargetEventTypes

Properties

Optional ClientRequestToken

ClientRequestToken?: string

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

DataAccessRoleArn

DataAccessRoleArn: undefined | string

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

InputDataConfig

InputDataConfig: undefined | InputDataConfig

Specifies the format and location of the input data for the job.

Optional JobName

JobName?: string

The identifier of the events detection job.

LanguageCode

LanguageCode: undefined | LanguageCode

The language code of the input documents.

OutputDataConfig

OutputDataConfig: undefined | OutputDataConfig

Specifies where to send the output files.

Optional Tags

Tags?: Tag[]

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.

TargetEventTypes

TargetEventTypes: undefined | string[]

The types of events to detect in the input documents.

Settings

Member Visibility

Theme

On This Page