AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartSentimentDetectionJob operation. Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Comprehend.AmazonComprehendRequest
      Amazon.Comprehend.Model.StartSentimentDetectionJobRequest

Namespace: Amazon.Comprehend.Model
Assembly: AWSSDK.Comprehend.dll
Version: 3.x.y.z

Syntax

C#
public class StartSentimentDetectionJobRequest : AmazonComprehendRequest
         IAmazonWebServiceRequest

The StartSentimentDetectionJobRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ClientRequestToken System.String

Gets and sets the property ClientRequestToken.

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

Public Property DataAccessRoleArn System.String

Gets and sets the property DataAccessRoleArn.

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.

Public Property InputDataConfig Amazon.Comprehend.Model.InputDataConfig

Gets and sets the property InputDataConfig.

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

Public Property JobName System.String

Gets and sets the property JobName.

The identifier of the job.

Public Property LanguageCode Amazon.Comprehend.LanguageCode

Gets and sets the property LanguageCode.

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Public Property OutputDataConfig Amazon.Comprehend.Model.OutputDataConfig

Gets and sets the property OutputDataConfig.

Specifies where to send the output files.

Public Property Tags System.Collections.Generic.List<Amazon.Comprehend.Model.Tag>

Gets and sets the property Tags.

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

Public Property VolumeKmsKeyId System.String

Gets and sets the property VolumeKmsKeyId.

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"

Public Property VpcConfig Amazon.Comprehend.Model.VpcConfig

Gets and sets the property VpcConfig.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5