Struct aws_sdk_comprehend::client::fluent_builders::StartSentimentDetectionJob

source · [−]

pub struct StartSentimentDetectionJob { /* private fields */ }

Expand description

Fluent builder constructing a request to StartSentimentDetectionJob.

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

Implementations

source

impl StartSentimentDetectionJob

source

pub async fn customize(
self
) -> Result<CustomizableOperation<StartSentimentDetectionJob, AwsResponseRetryClassifier>, SdkError<StartSentimentDetectionJobError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

source

pub async fn send(
self
) -> Result<StartSentimentDetectionJobOutput, SdkError<StartSentimentDetectionJobError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

source

pub fn input_data_config(self, input: InputDataConfig) -> Self

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

source

pub fn set_input_data_config(self, input: Option<InputDataConfig>) -> Self

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

source

pub fn output_data_config(self, input: OutputDataConfig) -> Self

Specifies where to send the output files.

source

pub fn set_output_data_config(self, input: Option<OutputDataConfig>) -> Self

Specifies where to send the output files.

source

pub fn data_access_role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

source

pub fn set_data_access_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

source

pub fn job_name(self, input: impl Into<String>) -> Self

The identifier of the job.

source

pub fn set_job_name(self, input: Option<String>) -> Self

The identifier of the job.

source

pub fn language_code(self, input: LanguageCode) -> Self

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.

source

pub fn set_language_code(self, input: Option<LanguageCode>) -> Self

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.

source

pub fn client_request_token(self, input: impl Into<String>) -> Self

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

source

pub fn set_client_request_token(self, input: Option<String>) -> Self

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

source

pub fn volume_kms_key_id(self, input: impl Into<String>) -> Self

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

source

pub fn set_volume_kms_key_id(self, input: Option<String>) -> Self

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

source

pub fn vpc_config(self, input: VpcConfig) -> Self

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.

source

pub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self

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.

source

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

Tags to be associated 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.

source

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Tags to be associated 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.