Interface DominantLanguageDetectionJobProperties

Provides information about a dominant language detection job.

interface DominantLanguageDetectionJobProperties {
    DataAccessRoleArn?: string;
    EndTime?: Date;
    InputDataConfig?: InputDataConfig;
    JobArn?: string;
    JobId?: string;
    JobName?: string;
    JobStatus?: JobStatus;
    Message?: string;
    OutputDataConfig?: OutputDataConfig;
    SubmitTime?: Date;
    VolumeKmsKeyId?: string;
    VpcConfig?: VpcConfig;
}

Properties

DataAccessRoleArn? EndTime? InputDataConfig? JobArn? JobId? JobName? JobStatus? Message? OutputDataConfig? SubmitTime? VolumeKmsKeyId? VpcConfig?

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 dominant language detection job completed.

Optional InputDataConfig

InputDataConfig?: InputDataConfig

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

Optional JobArn

JobArn?: string

The Amazon Resource Name (ARN) of the dominant language 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:::dominant-language-detection-job/

The following is an example job ARN:

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

Optional JobId

JobId?: string

The identifier assigned to the dominant language detection job.

Optional JobName

JobName?: string

The name that you assigned to the dominant language detection job.

Optional JobStatus

JobStatus?: JobStatus

The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.

Optional Message

Message?: string

A description for the status of a job.

Optional OutputDataConfig

OutputDataConfig?: OutputDataConfig

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

Optional SubmitTime

SubmitTime?: Date

The time that the dominant language detection job was submitted for processing.

Optional VolumeKmsKeyId

VolumeKmsKeyId?: string

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Optional VpcConfig

VpcConfig?: VpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.

Settings

Member Visibility

Theme

On This Page