Provides information about a sentiment detection job.

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

Properties

DataAccessRoleArn?: string

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

EndTime?: Date

The time that the sentiment detection job ended.

InputDataConfig?: InputDataConfig

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

JobArn?: string

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

The following is an example job ARN:

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

JobId?: string

The identifier assigned to the sentiment detection job.

JobName?: string

The name that you assigned to the sentiment detection job

JobStatus?: string

The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

LanguageCode?: string

The language code of the input documents.

Message?: string

A description of the status of a job.

OutputDataConfig?: OutputDataConfig

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

SubmitTime?: Date

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

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"

VpcConfig?: VpcConfig

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