ContainsPiiEntities - Amazon Comprehend API Reference


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.

Request Syntax

{ "LanguageCode": "string", "Text": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


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

Type: String

Valid Values: en

Required: Yes


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

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

{ "Labels": [ { "Name": "string", "Score": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.

Type: Array of EntityLabel objects


For information about the errors that are common to all actions, see Common Errors.


An internal server error occurred. Retry your request.

HTTP Status Code: 500


The request is invalid.

HTTP Status Code: 400


The size of the input text exceeds the limit. Use a smaller document.

HTTP Status Code: 400


Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: