| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Comprehend.DetectPiiEntities
Description
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
Synopsis
- data DetectPiiEntities = DetectPiiEntities' {
- text :: Text
- languageCode :: LanguageCode
- newDetectPiiEntities :: Text -> LanguageCode -> DetectPiiEntities
- detectPiiEntities_text :: Lens' DetectPiiEntities Text
- detectPiiEntities_languageCode :: Lens' DetectPiiEntities LanguageCode
- data DetectPiiEntitiesResponse = DetectPiiEntitiesResponse' {
- entities :: Maybe [PiiEntity]
- httpStatus :: Int
- newDetectPiiEntitiesResponse :: Int -> DetectPiiEntitiesResponse
- detectPiiEntitiesResponse_entities :: Lens' DetectPiiEntitiesResponse (Maybe [PiiEntity])
- detectPiiEntitiesResponse_httpStatus :: Lens' DetectPiiEntitiesResponse Int
Creating a Request
data DetectPiiEntities Source #
See: newDetectPiiEntities smart constructor.
Constructors
| DetectPiiEntities' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> LanguageCode | |
| -> DetectPiiEntities |
Create a value of DetectPiiEntities 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:
DetectPiiEntities, detectPiiEntities_text - A UTF-8 text string. The maximum string size is 100 KB.
DetectPiiEntities, detectPiiEntities_languageCode - The language of the input documents. Currently, English is the only
valid language.
Request Lenses
detectPiiEntities_text :: Lens' DetectPiiEntities Text Source #
A UTF-8 text string. The maximum string size is 100 KB.
detectPiiEntities_languageCode :: Lens' DetectPiiEntities LanguageCode Source #
The language of the input documents. Currently, English is the only valid language.
Destructuring the Response
data DetectPiiEntitiesResponse Source #
See: newDetectPiiEntitiesResponse smart constructor.
Constructors
| DetectPiiEntitiesResponse' | |
Fields
| |
Instances
newDetectPiiEntitiesResponse Source #
Create a value of DetectPiiEntitiesResponse 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:
DetectPiiEntitiesResponse, detectPiiEntitiesResponse_entities - 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.
$sel:httpStatus:DetectPiiEntitiesResponse', detectPiiEntitiesResponse_httpStatus - The response's http status code.
Response Lenses
detectPiiEntitiesResponse_entities :: Lens' DetectPiiEntitiesResponse (Maybe [PiiEntity]) Source #
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.
detectPiiEntitiesResponse_httpStatus :: Lens' DetectPiiEntitiesResponse Int Source #
The response's http status code.