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.ContainsPiiEntities

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

data ContainsPiiEntities Source #

See: newContainsPiiEntities smart constructor.

Constructors

ContainsPiiEntities'
Fields text :: Text A UTF-8 text string. The maximum string size is 100 KB. languageCode :: LanguageCode The language of the input documents. Currently, English is the only valid language.

Instances

Instances details

ToJSON ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods toJSON :: ContainsPiiEntities -> Value # toEncoding :: ContainsPiiEntities -> Encoding # toJSONList :: [ContainsPiiEntities] -> Value # toEncodingList :: [ContainsPiiEntities] -> Encoding #
ToHeaders ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods toHeaders :: ContainsPiiEntities -> [Header] #
ToPath ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods toPath :: ContainsPiiEntities -> ByteString #
ToQuery ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods toQuery :: ContainsPiiEntities -> QueryString #
AWSRequest ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Associated Types type AWSResponse ContainsPiiEntities # Methods request :: (Service -> Service) -> ContainsPiiEntities -> Request ContainsPiiEntities # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ContainsPiiEntities -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ContainsPiiEntities))) #
Generic ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Associated Types type Rep ContainsPiiEntities :: Type -> Type # Methods from :: ContainsPiiEntities -> Rep ContainsPiiEntities x # to :: Rep ContainsPiiEntities x -> ContainsPiiEntities #
Read ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods readsPrec :: Int -> ReadS ContainsPiiEntities # readList :: ReadS [ContainsPiiEntities] # readPrec :: ReadPrec ContainsPiiEntities # readListPrec :: ReadPrec [ContainsPiiEntities] #
Show ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods showsPrec :: Int -> ContainsPiiEntities -> ShowS # show :: ContainsPiiEntities -> String # showList :: [ContainsPiiEntities] -> ShowS #
NFData ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods rnf :: ContainsPiiEntities -> () #
Eq ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods (==) :: ContainsPiiEntities -> ContainsPiiEntities -> Bool # (/=) :: ContainsPiiEntities -> ContainsPiiEntities -> Bool #
Hashable ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods hashWithSalt :: Int -> ContainsPiiEntities -> Int # hash :: ContainsPiiEntities -> Int #
type AWSResponse ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities type AWSResponse ContainsPiiEntities = ContainsPiiEntitiesResponse
type Rep ContainsPiiEntities Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities type Rep ContainsPiiEntities = D1 ('MetaData "ContainsPiiEntities" "Amazonka.Comprehend.ContainsPiiEntities" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "ContainsPiiEntities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))

newContainsPiiEntities Source #

Arguments

:: Text	`ContainsPiiEntities`
-> LanguageCode	`ContainsPiiEntities`
-> 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:

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

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

Request Lenses

containsPiiEntities_text :: Lens' ContainsPiiEntities Text Source #

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

containsPiiEntities_languageCode :: Lens' ContainsPiiEntities LanguageCode Source #

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

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

Generic ContainsPiiEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Associated Types type Rep ContainsPiiEntitiesResponse :: Type -> Type # Methods from :: ContainsPiiEntitiesResponse -> Rep ContainsPiiEntitiesResponse x # to :: Rep ContainsPiiEntitiesResponse x -> ContainsPiiEntitiesResponse #
Read ContainsPiiEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods readsPrec :: Int -> ReadS ContainsPiiEntitiesResponse # readList :: ReadS [ContainsPiiEntitiesResponse] # readPrec :: ReadPrec ContainsPiiEntitiesResponse # readListPrec :: ReadPrec [ContainsPiiEntitiesResponse] #
Show ContainsPiiEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods showsPrec :: Int -> ContainsPiiEntitiesResponse -> ShowS # show :: ContainsPiiEntitiesResponse -> String # showList :: [ContainsPiiEntitiesResponse] -> ShowS #
NFData ContainsPiiEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods rnf :: ContainsPiiEntitiesResponse -> () #
Eq ContainsPiiEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities Methods (==) :: ContainsPiiEntitiesResponse -> ContainsPiiEntitiesResponse -> Bool # (/=) :: ContainsPiiEntitiesResponse -> ContainsPiiEntitiesResponse -> Bool #
type Rep ContainsPiiEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.ContainsPiiEntities type Rep ContainsPiiEntitiesResponse = D1 ('MetaData "ContainsPiiEntitiesResponse" "Amazonka.Comprehend.ContainsPiiEntities" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" '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 #

Arguments

:: Int	`$sel:httpStatus:ContainsPiiEntitiesResponse'`
-> ContainsPiiEntitiesResponse

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.