Interface TargetedSentimentDetectionJobProperties

Provides information about a targeted sentiment detection job.

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

Properties

DataAccessRoleArn? EndTime? InputDataConfig? JobArn? JobId? JobName? JobStatus? LanguageCode? 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 targeted sentiment detection job ended.

Optional InputDataConfig

InputDataConfig?: InputDataConfig

The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

Optional JobArn

JobArn?: string

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

The following is an example job ARN:

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

Optional JobId

JobId?: string

The identifier assigned to the targeted sentiment detection job.

Optional JobName

JobName?: string

The name that you assigned to the targeted sentiment detection job.

Optional JobStatus

JobStatus?: JobStatus

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

Optional LanguageCode

LanguageCode?: LanguageCode

The language code of the input documents.

Optional Message

Message?: string

A description of the status of a job.

Optional OutputDataConfig

OutputDataConfig?: OutputDataConfig

Provides configuration parameters for the output of inference jobs.

Optional SubmitTime

SubmitTime?: Date

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

Optional VolumeKmsKeyId

VolumeKmsKeyId?: string

ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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 an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

Settings

Member Visibility

Theme

On This Page