Struct aws_sdk_comprehend::input::StartPiiEntitiesDetectionJobInput

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

Implementations

impl StartPiiEntitiesDetectionJobInput

pub async fn make_operation(
    self,
    _config: &Config
) -> Result<Operation<StartPiiEntitiesDetectionJob, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<StartPiiEntitiesDetectionJob>

Examples found in repository

src/client.rs (line 7015)

        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
        }

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartPiiEntitiesDetectionJobInput.

impl StartPiiEntitiesDetectionJobInput

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

The input properties for a PII entities detection job.

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

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

pub fn mode(&self) -> Option<&PiiEntitiesDetectionMode>

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

pub fn redaction_config(&self) -> Option<&RedactionConfig>

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.

pub fn data_access_role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

pub fn job_name(&self) -> Option<&str>

The identifier of the job.

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

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

pub fn client_request_token(&self) -> Option<&str>

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

pub fn tags(&self) -> Option<&[Tag]>

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.

Trait Implementations

impl Clone for StartPiiEntitiesDetectionJobInput

fn clone(&self) -> StartPiiEntitiesDetectionJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartPiiEntitiesDetectionJobInput

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

Formats the value using the given formatter.

impl PartialEq<StartPiiEntitiesDetectionJobInput> for StartPiiEntitiesDetectionJobInput

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