Struct aws_sdk_comprehend::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobInputBuilder

#[non_exhaustive]
pub struct StartTargetedSentimentDetectionJobInputBuilder { /* private fields */ }

A builder for StartTargetedSentimentDetectionJobInput.

Implementations

impl StartTargetedSentimentDetectionJobInputBuilder

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

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

This field is required.

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

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

pub fn get_input_data_config(&self) -> &Option<InputDataConfig>

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

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

Specifies where to send the output files.

This field is required.

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

Specifies where to send the output files.

pub fn get_output_data_config(&self) -> &Option<OutputDataConfig>

Specifies where to send the output files.

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

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.

This field is required.

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

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.

pub fn get_data_access_role_arn(&self) -> &Option<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.

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

The identifier of the job.

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

The identifier of the job.

pub fn get_job_name(&self) -> &Option<String>

The identifier of the job.

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

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

This field is required.

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

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

pub fn get_language_code(&self) -> &Option<LanguageCode>

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

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.

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.

pub fn get_client_request_token(&self) -> &Option<String>

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

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

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"

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

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"

pub fn get_volume_kms_key_id(&self) -> &Option<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"

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 the job. For more information, see Amazon VPC.

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 the job. For more information, see Amazon VPC.

pub fn get_vpc_config(&self) -> &Option<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.

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

Appends an item to tags.

To override the contents of this collection use set_tags.

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.

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

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.

pub fn get_tags(&self) -> &Option<Vec<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.

pub fn build( self ) -> Result<StartTargetedSentimentDetectionJobInput, BuildError>

Consumes the builder and constructs a StartTargetedSentimentDetectionJobInput.

impl StartTargetedSentimentDetectionJobInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<StartTargetedSentimentDetectionJobOutput, SdkError<StartTargetedSentimentDetectionJobError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for StartTargetedSentimentDetectionJobInputBuilder

fn clone(&self) -> StartTargetedSentimentDetectionJobInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartTargetedSentimentDetectionJobInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StartTargetedSentimentDetectionJobInputBuilder

fn default() -> StartTargetedSentimentDetectionJobInputBuilder

Returns the “default value” for a type.

impl PartialEq for StartTargetedSentimentDetectionJobInputBuilder

fn eq(&self, other: &StartTargetedSentimentDetectionJobInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartTargetedSentimentDetectionJobInputBuilder