Struct aws_sdk_comprehend::input::start_pii_entities_detection_job_input::Builder

pub struct Builder { /* private fields */ }

A builder for StartPiiEntitiesDetectionJobInput.

Implementations

impl Builder

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

The input properties for a PII entities detection job.

Examples found in repository

src/client.rs (line 7046)

        pub fn input_data_config(mut self, input: crate::model::InputDataConfig) -> Self {
            self.inner = self.inner.input_data_config(input);
            self
        }

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

The input properties for a PII entities detection job.

Examples found in repository

src/client.rs (line 7054)

        pub fn set_input_data_config(
            mut self,
            input: std::option::Option<crate::model::InputDataConfig>,
        ) -> Self {
            self.inner = self.inner.set_input_data_config(input);
            self
        }

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

Provides configuration parameters for the output of PII entity detection jobs.

Examples found in repository

src/client.rs (line 7059)

        pub fn output_data_config(mut self, input: crate::model::OutputDataConfig) -> Self {
            self.inner = self.inner.output_data_config(input);
            self
        }

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

Provides configuration parameters for the output of PII entity detection jobs.

Examples found in repository

src/client.rs (line 7067)

        pub fn set_output_data_config(
            mut self,
            input: std::option::Option<crate::model::OutputDataConfig>,
        ) -> Self {
            self.inner = self.inner.set_output_data_config(input);
            self
        }

pub fn mode(self, input: PiiEntitiesDetectionMode) -> Self

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

Examples found in repository

src/client.rs (line 7072)

        pub fn mode(mut self, input: crate::model::PiiEntitiesDetectionMode) -> Self {
            self.inner = self.inner.mode(input);
            self
        }

pub fn set_mode(self, input: Option<PiiEntitiesDetectionMode>) -> Self

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

Examples found in repository

src/client.rs (line 7080)

        pub fn set_mode(
            mut self,
            input: std::option::Option<crate::model::PiiEntitiesDetectionMode>,
        ) -> Self {
            self.inner = self.inner.set_mode(input);
            self
        }

pub fn redaction_config(self, input: RedactionConfig) -> Self

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

Examples found in repository

src/client.rs (line 7086)

        pub fn redaction_config(mut self, input: crate::model::RedactionConfig) -> Self {
            self.inner = self.inner.redaction_config(input);
            self
        }

pub fn set_redaction_config(self, input: Option<RedactionConfig>) -> Self

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

Examples found in repository

src/client.rs (line 7095)

        pub fn set_redaction_config(
            mut self,
            input: std::option::Option<crate::model::RedactionConfig>,
        ) -> Self {
            self.inner = self.inner.set_redaction_config(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 7100)

        pub fn data_access_role_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.data_access_role_arn(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 7108)

        pub fn set_data_access_role_arn(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_data_access_role_arn(input);
            self
        }

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

The identifier of the job.

Examples found in repository

src/client.rs (line 7113)

        pub fn job_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.job_name(input.into());
            self
        }

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

The identifier of the job.

Examples found in repository

src/client.rs (line 7118)

        pub fn set_job_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_job_name(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 7123)

        pub fn language_code(mut self, input: crate::model::LanguageCode) -> Self {
            self.inner = self.inner.language_code(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 7131)

        pub fn set_language_code(
            mut self,
            input: std::option::Option<crate::model::LanguageCode>,
        ) -> Self {
            self.inner = self.inner.set_language_code(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 7136)

        pub fn client_request_token(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.client_request_token(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 7144)

        pub fn set_client_request_token(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_client_request_token(input);
            self
        }

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 PII entities 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.

Examples found in repository

src/client.rs (line 7153)

        pub fn tags(mut self, input: crate::model::Tag) -> Self {
            self.inner = self.inner.tags(input);
            self
        }

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

Tags to be associated with the PII entities 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.

Examples found in repository

src/client.rs (line 7161)

        pub fn set_tags(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
        ) -> Self {
            self.inner = self.inner.set_tags(input);
            self
        }

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

Consumes the builder and constructs a StartPiiEntitiesDetectionJobInput.

Examples found in repository

src/client.rs (line 7013)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::StartPiiEntitiesDetectionJob,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::StartPiiEntitiesDetectionJobError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::StartPiiEntitiesDetectionJobOutput,
            aws_smithy_http::result::SdkError<crate::error::StartPiiEntitiesDetectionJobError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> 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 Builder