Skip to content

contains_pii_entities 

contains_pii_entities(
    text: String,
    language_code: LanguageCode,
    *,
    config_overrides: Optional[ComprehendClientConfig] = None,
) -> ContainsPiiEntitiesResponse

Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.

Parameters:

  • text (String) –

    A UTF-8 text string. The maximum string size is 100 KB.

  • language_code (LanguageCode) –

    The language of the input documents.

Raises:

Source code in docs_src/capo_comprehend/_services/comprehend.py 
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
def contains_pii_entities(
    self,
    text: "capo_comprehend.types.string.String",
    language_code: "capo_comprehend.types.language_code.LanguageCode",
    *,
    config_overrides: Optional[ComprehendClientConfig] = None,
) -> "capo_comprehend.types.contains_pii_entities_response.ContainsPiiEntitiesResponse":
    """<p>Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.</p>

    Args:
        text: <p>A UTF-8 text string. The maximum string size is 100 KB.</p>
        language_code: <p>The language of the input documents.</p>

    Raises:
        capo_comprehend.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_comprehend.errors.invalid_request_exception.InvalidRequestException: <p>The request is invalid.</p>
        capo_comprehend.errors.text_size_limit_exceeded_exception.TextSizeLimitExceededException: <p>The size of the input text exceeds the limit. Use a smaller document.</p>
        capo_comprehend.errors.unsupported_language_exception.UnsupportedLanguageException: <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages, <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide. </p>
        capo_comprehend.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_comprehend.types.contains_pii_entities_request.ContainsPiiEntitiesRequest]",
    ) -> OperationResponse[
        "capo_comprehend.types.contains_pii_entities_response.ContainsPiiEntitiesResponse"
    ]:
        import capo_comprehend._operations.comprehend_20171127.contains_pii_entities

        output, http_response = (
            capo_comprehend._operations.comprehend_20171127.contains_pii_entities.contains_pii_entities(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ContainsPiiEntities")
    )
    input_: capo_comprehend.types.contains_pii_entities_request.ContainsPiiEntitiesRequest = {
        "text": text,
        "language_code": language_code,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output