Interface StartTargetedSentimentDetectionJobRequest

interface StartTargetedSentimentDetectionJobRequest {
    ClientRequestToken?: string;
    DataAccessRoleArn: undefined | string;
    InputDataConfig: undefined | InputDataConfig;
    JobName?: string;
    LanguageCode: undefined | LanguageCode;
    OutputDataConfig: undefined | OutputDataConfig;
    Tags?: Tag[];
    VolumeKmsKeyId?: string;
    VpcConfig?: VpcConfig;
}

Hierarchy (view full)

Properties

ClientRequestToken? DataAccessRoleArn InputDataConfig JobName? LanguageCode OutputDataConfig Tags? VolumeKmsKeyId? VpcConfig?

Properties

Optional ClientRequestToken

ClientRequestToken?: string

A 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. For more information, see Role-based permissions.

InputDataConfig

InputDataConfig: undefined | InputDataConfig

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

Optional JobName

JobName?: string

The identifier of the job.

LanguageCode

LanguageCode: undefined | LanguageCode

The language of the input documents. Currently, English is the only supported language.

OutputDataConfig

OutputDataConfig: undefined | OutputDataConfig

Specifies where to send the output files.

Optional Tags

Tags?: Tag[]

Tags to associate with the targeted sentiment 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.

Optional VolumeKmsKeyId

VolumeKmsKeyId?: string

ID for the 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 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