aws_sdk_comprehend/client/
detect_pii_entities.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DetectPiiEntities`](crate::operation::detect_pii_entities::builders::DetectPiiEntitiesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`text(impl Into<String>)`](crate::operation::detect_pii_entities::builders::DetectPiiEntitiesFluentBuilder::text) / [`set_text(Option<String>)`](crate::operation::detect_pii_entities::builders::DetectPiiEntitiesFluentBuilder::set_text):<br>required: **true**<br><p>A UTF-8 text string. The maximum string size is 100 KB.</p><br>
7    ///   - [`language_code(LanguageCode)`](crate::operation::detect_pii_entities::builders::DetectPiiEntitiesFluentBuilder::language_code) / [`set_language_code(Option<LanguageCode>)`](crate::operation::detect_pii_entities::builders::DetectPiiEntitiesFluentBuilder::set_language_code):<br>required: **true**<br><p>The language of the input text. Enter the language code for English (en) or Spanish (es).</p><br>
8    /// - On success, responds with [`DetectPiiEntitiesOutput`](crate::operation::detect_pii_entities::DetectPiiEntitiesOutput) with field(s):
9    ///   - [`entities(Option<Vec::<PiiEntity>>)`](crate::operation::detect_pii_entities::DetectPiiEntitiesOutput::entities): <p>A collection of PII entities identified in the input text. For each entity, the response provides the entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.</p>
10    /// - On failure, responds with [`SdkError<DetectPiiEntitiesError>`](crate::operation::detect_pii_entities::DetectPiiEntitiesError)
11    pub fn detect_pii_entities(&self) -> crate::operation::detect_pii_entities::builders::DetectPiiEntitiesFluentBuilder {
12        crate::operation::detect_pii_entities::builders::DetectPiiEntitiesFluentBuilder::new(self.handle.clone())
13    }
14}