libZSservicesZSamazonka-comprehendZSamazonka-comprehend
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data ContainsPiiEntities Source #

See: newContainsPiiEntities smart constructor.

Constructors

ContainsPiiEntities' 

Fields

  • text :: Text

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

  • languageCode :: LanguageCode

    The language of the input documents.

Instances

Instances details
Eq ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Read ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Show ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Generic ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Associated Types

type Rep ContainsPiiEntities :: Type -> Type #

NFData ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Methods

rnf :: ContainsPiiEntities -> () #

Hashable ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

ToJSON ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

AWSRequest ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Associated Types

type AWSResponse ContainsPiiEntities #

ToHeaders ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

ToPath ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

ToQuery ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

type Rep ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

type Rep ContainsPiiEntities = D1 ('MetaData "ContainsPiiEntities" "Amazonka.Comprehend.ContainsPiiEntities" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ContainsPiiEntities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))
type AWSResponse ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

newContainsPiiEntities Source #

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.

Destructuring the Response

data ContainsPiiEntitiesResponse Source #

See: newContainsPiiEntitiesResponse smart constructor.

Constructors

ContainsPiiEntitiesResponse' 

Fields

  • labels :: Maybe [EntityLabel]

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Read ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Show ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Generic ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Associated Types

type Rep ContainsPiiEntitiesResponse :: Type -> Type #

NFData ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

type Rep ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

type Rep ContainsPiiEntitiesResponse = D1 ('MetaData "ContainsPiiEntitiesResponse" "Amazonka.Comprehend.ContainsPiiEntities" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ContainsPiiEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntityLabel])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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.