{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Comprehend.DetectPiiEntities
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Inspects the input text for entities that contain personally
-- identifiable information (PII) and returns information about them.
module Amazonka.Comprehend.DetectPiiEntities
  ( -- * Creating a Request
    DetectPiiEntities (..),
    newDetectPiiEntities,

    -- * Request Lenses
    detectPiiEntities_text,
    detectPiiEntities_languageCode,

    -- * Destructuring the Response
    DetectPiiEntitiesResponse (..),
    newDetectPiiEntitiesResponse,

    -- * Response Lenses
    detectPiiEntitiesResponse_entities,
    detectPiiEntitiesResponse_httpStatus,
  )
where

import Amazonka.Comprehend.Types
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDetectPiiEntities' smart constructor.
data DetectPiiEntities = DetectPiiEntities'
  { -- | A UTF-8 text string. The maximum string size is 100 KB.
    DetectPiiEntities -> Text
text :: Prelude.Text,
    -- | The language of the input documents. Currently, English is the only
    -- valid language.
    DetectPiiEntities -> LanguageCode
languageCode :: LanguageCode
  }
  deriving (DetectPiiEntities -> DetectPiiEntities -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DetectPiiEntities -> DetectPiiEntities -> Bool
$c/= :: DetectPiiEntities -> DetectPiiEntities -> Bool
== :: DetectPiiEntities -> DetectPiiEntities -> Bool
$c== :: DetectPiiEntities -> DetectPiiEntities -> Bool
Prelude.Eq, ReadPrec [DetectPiiEntities]
ReadPrec DetectPiiEntities
Int -> ReadS DetectPiiEntities
ReadS [DetectPiiEntities]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DetectPiiEntities]
$creadListPrec :: ReadPrec [DetectPiiEntities]
readPrec :: ReadPrec DetectPiiEntities
$creadPrec :: ReadPrec DetectPiiEntities
readList :: ReadS [DetectPiiEntities]
$creadList :: ReadS [DetectPiiEntities]
readsPrec :: Int -> ReadS DetectPiiEntities
$creadsPrec :: Int -> ReadS DetectPiiEntities
Prelude.Read, Int -> DetectPiiEntities -> ShowS
[DetectPiiEntities] -> ShowS
DetectPiiEntities -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DetectPiiEntities] -> ShowS
$cshowList :: [DetectPiiEntities] -> ShowS
show :: DetectPiiEntities -> String
$cshow :: DetectPiiEntities -> String
showsPrec :: Int -> DetectPiiEntities -> ShowS
$cshowsPrec :: Int -> DetectPiiEntities -> ShowS
Prelude.Show, forall x. Rep DetectPiiEntities x -> DetectPiiEntities
forall x. DetectPiiEntities -> Rep DetectPiiEntities x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DetectPiiEntities x -> DetectPiiEntities
$cfrom :: forall x. DetectPiiEntities -> Rep DetectPiiEntities x
Prelude.Generic)

-- |
-- Create a value of 'DetectPiiEntities' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'text', 'detectPiiEntities_text' - A UTF-8 text string. The maximum string size is 100 KB.
--
-- 'languageCode', 'detectPiiEntities_languageCode' - The language of the input documents. Currently, English is the only
-- valid language.
newDetectPiiEntities ::
  -- | 'text'
  Prelude.Text ->
  -- | 'languageCode'
  LanguageCode ->
  DetectPiiEntities
newDetectPiiEntities :: Text -> LanguageCode -> DetectPiiEntities
newDetectPiiEntities Text
pText_ LanguageCode
pLanguageCode_ =
  DetectPiiEntities'
    { $sel:text:DetectPiiEntities' :: Text
text = Text
pText_,
      $sel:languageCode:DetectPiiEntities' :: LanguageCode
languageCode = LanguageCode
pLanguageCode_
    }

-- | A UTF-8 text string. The maximum string size is 100 KB.
detectPiiEntities_text :: Lens.Lens' DetectPiiEntities Prelude.Text
detectPiiEntities_text :: Lens' DetectPiiEntities Text
detectPiiEntities_text = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DetectPiiEntities' {Text
text :: Text
$sel:text:DetectPiiEntities' :: DetectPiiEntities -> Text
text} -> Text
text) (\s :: DetectPiiEntities
s@DetectPiiEntities' {} Text
a -> DetectPiiEntities
s {$sel:text:DetectPiiEntities' :: Text
text = Text
a} :: DetectPiiEntities)

-- | The language of the input documents. Currently, English is the only
-- valid language.
detectPiiEntities_languageCode :: Lens.Lens' DetectPiiEntities LanguageCode
detectPiiEntities_languageCode :: Lens' DetectPiiEntities LanguageCode
detectPiiEntities_languageCode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DetectPiiEntities' {LanguageCode
languageCode :: LanguageCode
$sel:languageCode:DetectPiiEntities' :: DetectPiiEntities -> LanguageCode
languageCode} -> LanguageCode
languageCode) (\s :: DetectPiiEntities
s@DetectPiiEntities' {} LanguageCode
a -> DetectPiiEntities
s {$sel:languageCode:DetectPiiEntities' :: LanguageCode
languageCode = LanguageCode
a} :: DetectPiiEntities)

instance Core.AWSRequest DetectPiiEntities where
  type
    AWSResponse DetectPiiEntities =
      DetectPiiEntitiesResponse
  request :: (Service -> Service)
-> DetectPiiEntities -> Request DetectPiiEntities
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DetectPiiEntities
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DetectPiiEntities)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [PiiEntity] -> Int -> DetectPiiEntitiesResponse
DetectPiiEntitiesResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Entities" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DetectPiiEntities where
  hashWithSalt :: Int -> DetectPiiEntities -> Int
hashWithSalt Int
_salt DetectPiiEntities' {Text
LanguageCode
languageCode :: LanguageCode
text :: Text
$sel:languageCode:DetectPiiEntities' :: DetectPiiEntities -> LanguageCode
$sel:text:DetectPiiEntities' :: DetectPiiEntities -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
text
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` LanguageCode
languageCode

instance Prelude.NFData DetectPiiEntities where
  rnf :: DetectPiiEntities -> ()
rnf DetectPiiEntities' {Text
LanguageCode
languageCode :: LanguageCode
text :: Text
$sel:languageCode:DetectPiiEntities' :: DetectPiiEntities -> LanguageCode
$sel:text:DetectPiiEntities' :: DetectPiiEntities -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
text
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf LanguageCode
languageCode

instance Data.ToHeaders DetectPiiEntities where
  toHeaders :: DetectPiiEntities -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"Comprehend_20171127.DetectPiiEntities" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DetectPiiEntities where
  toJSON :: DetectPiiEntities -> Value
toJSON DetectPiiEntities' {Text
LanguageCode
languageCode :: LanguageCode
text :: Text
$sel:languageCode:DetectPiiEntities' :: DetectPiiEntities -> LanguageCode
$sel:text:DetectPiiEntities' :: DetectPiiEntities -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"Text" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
text),
            forall a. a -> Maybe a
Prelude.Just (Key
"LanguageCode" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= LanguageCode
languageCode)
          ]
      )

instance Data.ToPath DetectPiiEntities where
  toPath :: DetectPiiEntities -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery DetectPiiEntities where
  toQuery :: DetectPiiEntities -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newDetectPiiEntitiesResponse' smart constructor.
data DetectPiiEntitiesResponse = DetectPiiEntitiesResponse'
  { -- | 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 -> Maybe [PiiEntity]
entities :: Prelude.Maybe [PiiEntity],
    -- | The response's http status code.
    DetectPiiEntitiesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DetectPiiEntitiesResponse -> DetectPiiEntitiesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DetectPiiEntitiesResponse -> DetectPiiEntitiesResponse -> Bool
$c/= :: DetectPiiEntitiesResponse -> DetectPiiEntitiesResponse -> Bool
== :: DetectPiiEntitiesResponse -> DetectPiiEntitiesResponse -> Bool
$c== :: DetectPiiEntitiesResponse -> DetectPiiEntitiesResponse -> Bool
Prelude.Eq, ReadPrec [DetectPiiEntitiesResponse]
ReadPrec DetectPiiEntitiesResponse
Int -> ReadS DetectPiiEntitiesResponse
ReadS [DetectPiiEntitiesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DetectPiiEntitiesResponse]
$creadListPrec :: ReadPrec [DetectPiiEntitiesResponse]
readPrec :: ReadPrec DetectPiiEntitiesResponse
$creadPrec :: ReadPrec DetectPiiEntitiesResponse
readList :: ReadS [DetectPiiEntitiesResponse]
$creadList :: ReadS [DetectPiiEntitiesResponse]
readsPrec :: Int -> ReadS DetectPiiEntitiesResponse
$creadsPrec :: Int -> ReadS DetectPiiEntitiesResponse
Prelude.Read, Int -> DetectPiiEntitiesResponse -> ShowS
[DetectPiiEntitiesResponse] -> ShowS
DetectPiiEntitiesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DetectPiiEntitiesResponse] -> ShowS
$cshowList :: [DetectPiiEntitiesResponse] -> ShowS
show :: DetectPiiEntitiesResponse -> String
$cshow :: DetectPiiEntitiesResponse -> String
showsPrec :: Int -> DetectPiiEntitiesResponse -> ShowS
$cshowsPrec :: Int -> DetectPiiEntitiesResponse -> ShowS
Prelude.Show, forall x.
Rep DetectPiiEntitiesResponse x -> DetectPiiEntitiesResponse
forall x.
DetectPiiEntitiesResponse -> Rep DetectPiiEntitiesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DetectPiiEntitiesResponse x -> DetectPiiEntitiesResponse
$cfrom :: forall x.
DetectPiiEntitiesResponse -> Rep DetectPiiEntitiesResponse x
Prelude.Generic)

-- |
-- Create a value of 'DetectPiiEntitiesResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'entities', '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.
--
-- 'httpStatus', 'detectPiiEntitiesResponse_httpStatus' - The response's http status code.
newDetectPiiEntitiesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DetectPiiEntitiesResponse
newDetectPiiEntitiesResponse :: Int -> DetectPiiEntitiesResponse
newDetectPiiEntitiesResponse Int
pHttpStatus_ =
  DetectPiiEntitiesResponse'
    { $sel:entities:DetectPiiEntitiesResponse' :: Maybe [PiiEntity]
entities =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DetectPiiEntitiesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | 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_entities :: Lens.Lens' DetectPiiEntitiesResponse (Prelude.Maybe [PiiEntity])
detectPiiEntitiesResponse_entities :: Lens' DetectPiiEntitiesResponse (Maybe [PiiEntity])
detectPiiEntitiesResponse_entities = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DetectPiiEntitiesResponse' {Maybe [PiiEntity]
entities :: Maybe [PiiEntity]
$sel:entities:DetectPiiEntitiesResponse' :: DetectPiiEntitiesResponse -> Maybe [PiiEntity]
entities} -> Maybe [PiiEntity]
entities) (\s :: DetectPiiEntitiesResponse
s@DetectPiiEntitiesResponse' {} Maybe [PiiEntity]
a -> DetectPiiEntitiesResponse
s {$sel:entities:DetectPiiEntitiesResponse' :: Maybe [PiiEntity]
entities = Maybe [PiiEntity]
a} :: DetectPiiEntitiesResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The response's http status code.
detectPiiEntitiesResponse_httpStatus :: Lens.Lens' DetectPiiEntitiesResponse Prelude.Int
detectPiiEntitiesResponse_httpStatus :: Lens' DetectPiiEntitiesResponse Int
detectPiiEntitiesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DetectPiiEntitiesResponse' {Int
httpStatus :: Int
$sel:httpStatus:DetectPiiEntitiesResponse' :: DetectPiiEntitiesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DetectPiiEntitiesResponse
s@DetectPiiEntitiesResponse' {} Int
a -> DetectPiiEntitiesResponse
s {$sel:httpStatus:DetectPiiEntitiesResponse' :: Int
httpStatus = Int
a} :: DetectPiiEntitiesResponse)

instance Prelude.NFData DetectPiiEntitiesResponse where
  rnf :: DetectPiiEntitiesResponse -> ()
rnf DetectPiiEntitiesResponse' {Int
Maybe [PiiEntity]
httpStatus :: Int
entities :: Maybe [PiiEntity]
$sel:httpStatus:DetectPiiEntitiesResponse' :: DetectPiiEntitiesResponse -> Int
$sel:entities:DetectPiiEntitiesResponse' :: DetectPiiEntitiesResponse -> Maybe [PiiEntity]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [PiiEntity]
entities
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus