| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Comprehend.ContainsPiiEntities
Description
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.
Synopsis
- data ContainsPiiEntities = ContainsPiiEntities' {
- text :: Text
- languageCode :: LanguageCode
- newContainsPiiEntities :: Text -> LanguageCode -> ContainsPiiEntities
- containsPiiEntities_text :: Lens' ContainsPiiEntities Text
- containsPiiEntities_languageCode :: Lens' ContainsPiiEntities LanguageCode
- data ContainsPiiEntitiesResponse = ContainsPiiEntitiesResponse' {
- labels :: Maybe [EntityLabel]
- httpStatus :: Int
- newContainsPiiEntitiesResponse :: Int -> ContainsPiiEntitiesResponse
- containsPiiEntitiesResponse_labels :: Lens' ContainsPiiEntitiesResponse (Maybe [EntityLabel])
- containsPiiEntitiesResponse_httpStatus :: Lens' ContainsPiiEntitiesResponse Int
Creating a Request
data ContainsPiiEntities Source #
See: newContainsPiiEntities smart constructor.
Constructors
| ContainsPiiEntities' | |
Fields
| |
Instances
newContainsPiiEntities Source #
Arguments
| :: Text | |
| -> LanguageCode | |
| -> ContainsPiiEntities |
Create a value of ContainsPiiEntities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:ContainsPiiEntities', containsPiiEntities_text - Creates a new document classification request to analyze a single
document in real-time, returning personally identifiable information
(PII) entity labels.
$sel:languageCode:ContainsPiiEntities', containsPiiEntities_languageCode - The language of the input documents.
Request Lenses
containsPiiEntities_text :: Lens' ContainsPiiEntities Text Source #
Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.
containsPiiEntities_languageCode :: Lens' ContainsPiiEntities LanguageCode Source #
The language of the input documents.
Destructuring the Response
data ContainsPiiEntitiesResponse Source #
See: newContainsPiiEntitiesResponse smart constructor.
Constructors
| ContainsPiiEntitiesResponse' | |
Fields
| |
Instances
newContainsPiiEntitiesResponse Source #
Create a value of ContainsPiiEntitiesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:labels:ContainsPiiEntitiesResponse', containsPiiEntitiesResponse_labels - The labels used in the document being analyzed. Individual labels
represent personally identifiable information (PII) entity types.
$sel:httpStatus:ContainsPiiEntitiesResponse', containsPiiEntitiesResponse_httpStatus - The response's http status code.
Response Lenses
containsPiiEntitiesResponse_labels :: Lens' ContainsPiiEntitiesResponse (Maybe [EntityLabel]) Source #
The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.
containsPiiEntitiesResponse_httpStatus :: Lens' ContainsPiiEntitiesResponse Int Source #
The response's http status code.