[ aws . comprehend ]



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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--text <value>
--language-code <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--text (string)

Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.

--language-code (string)

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

Possible values:

  • en

  • es

  • fr

  • de

  • it

  • pt

  • ar

  • hi

  • ja

  • ko

  • zh

  • zh-TW

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


Labels -> (list)

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


Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.

Name -> (string)

The name of the label.

Score -> (float)

The level of confidence that Amazon Comprehend has in the accuracy of the detection.