{-# 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.DescribeEntityRecognizer
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Provides details about an entity recognizer including status, S3 buckets
-- containing training data, recognizer metadata, metrics, and so on.
module Amazonka.Comprehend.DescribeEntityRecognizer
  ( -- * Creating a Request
    DescribeEntityRecognizer (..),
    newDescribeEntityRecognizer,

    -- * Request Lenses
    describeEntityRecognizer_entityRecognizerArn,

    -- * Destructuring the Response
    DescribeEntityRecognizerResponse (..),
    newDescribeEntityRecognizerResponse,

    -- * Response Lenses
    describeEntityRecognizerResponse_entityRecognizerProperties,
    describeEntityRecognizerResponse_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:/ 'newDescribeEntityRecognizer' smart constructor.
data DescribeEntityRecognizer = DescribeEntityRecognizer'
  { -- | The Amazon Resource Name (ARN) that identifies the entity recognizer.
    DescribeEntityRecognizer -> Text
entityRecognizerArn :: Prelude.Text
  }
  deriving (DescribeEntityRecognizer -> DescribeEntityRecognizer -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeEntityRecognizer -> DescribeEntityRecognizer -> Bool
$c/= :: DescribeEntityRecognizer -> DescribeEntityRecognizer -> Bool
== :: DescribeEntityRecognizer -> DescribeEntityRecognizer -> Bool
$c== :: DescribeEntityRecognizer -> DescribeEntityRecognizer -> Bool
Prelude.Eq, ReadPrec [DescribeEntityRecognizer]
ReadPrec DescribeEntityRecognizer
Int -> ReadS DescribeEntityRecognizer
ReadS [DescribeEntityRecognizer]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeEntityRecognizer]
$creadListPrec :: ReadPrec [DescribeEntityRecognizer]
readPrec :: ReadPrec DescribeEntityRecognizer
$creadPrec :: ReadPrec DescribeEntityRecognizer
readList :: ReadS [DescribeEntityRecognizer]
$creadList :: ReadS [DescribeEntityRecognizer]
readsPrec :: Int -> ReadS DescribeEntityRecognizer
$creadsPrec :: Int -> ReadS DescribeEntityRecognizer
Prelude.Read, Int -> DescribeEntityRecognizer -> ShowS
[DescribeEntityRecognizer] -> ShowS
DescribeEntityRecognizer -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeEntityRecognizer] -> ShowS
$cshowList :: [DescribeEntityRecognizer] -> ShowS
show :: DescribeEntityRecognizer -> String
$cshow :: DescribeEntityRecognizer -> String
showsPrec :: Int -> DescribeEntityRecognizer -> ShowS
$cshowsPrec :: Int -> DescribeEntityRecognizer -> ShowS
Prelude.Show, forall x.
Rep DescribeEntityRecognizer x -> DescribeEntityRecognizer
forall x.
DescribeEntityRecognizer -> Rep DescribeEntityRecognizer x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeEntityRecognizer x -> DescribeEntityRecognizer
$cfrom :: forall x.
DescribeEntityRecognizer -> Rep DescribeEntityRecognizer x
Prelude.Generic)

-- |
-- Create a value of 'DescribeEntityRecognizer' 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:
--
-- 'entityRecognizerArn', 'describeEntityRecognizer_entityRecognizerArn' - The Amazon Resource Name (ARN) that identifies the entity recognizer.
newDescribeEntityRecognizer ::
  -- | 'entityRecognizerArn'
  Prelude.Text ->
  DescribeEntityRecognizer
newDescribeEntityRecognizer :: Text -> DescribeEntityRecognizer
newDescribeEntityRecognizer Text
pEntityRecognizerArn_ =
  DescribeEntityRecognizer'
    { $sel:entityRecognizerArn:DescribeEntityRecognizer' :: Text
entityRecognizerArn =
        Text
pEntityRecognizerArn_
    }

-- | The Amazon Resource Name (ARN) that identifies the entity recognizer.
describeEntityRecognizer_entityRecognizerArn :: Lens.Lens' DescribeEntityRecognizer Prelude.Text
describeEntityRecognizer_entityRecognizerArn :: Lens' DescribeEntityRecognizer Text
describeEntityRecognizer_entityRecognizerArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEntityRecognizer' {Text
entityRecognizerArn :: Text
$sel:entityRecognizerArn:DescribeEntityRecognizer' :: DescribeEntityRecognizer -> Text
entityRecognizerArn} -> Text
entityRecognizerArn) (\s :: DescribeEntityRecognizer
s@DescribeEntityRecognizer' {} Text
a -> DescribeEntityRecognizer
s {$sel:entityRecognizerArn:DescribeEntityRecognizer' :: Text
entityRecognizerArn = Text
a} :: DescribeEntityRecognizer)

instance Core.AWSRequest DescribeEntityRecognizer where
  type
    AWSResponse DescribeEntityRecognizer =
      DescribeEntityRecognizerResponse
  request :: (Service -> Service)
-> DescribeEntityRecognizer -> Request DescribeEntityRecognizer
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 DescribeEntityRecognizer
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeEntityRecognizer)))
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 EntityRecognizerProperties
-> Int -> DescribeEntityRecognizerResponse
DescribeEntityRecognizerResponse'
            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
"EntityRecognizerProperties")
            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 DescribeEntityRecognizer where
  hashWithSalt :: Int -> DescribeEntityRecognizer -> Int
hashWithSalt Int
_salt DescribeEntityRecognizer' {Text
entityRecognizerArn :: Text
$sel:entityRecognizerArn:DescribeEntityRecognizer' :: DescribeEntityRecognizer -> Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
entityRecognizerArn

instance Prelude.NFData DescribeEntityRecognizer where
  rnf :: DescribeEntityRecognizer -> ()
rnf DescribeEntityRecognizer' {Text
entityRecognizerArn :: Text
$sel:entityRecognizerArn:DescribeEntityRecognizer' :: DescribeEntityRecognizer -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
entityRecognizerArn

instance Data.ToHeaders DescribeEntityRecognizer where
  toHeaders :: DescribeEntityRecognizer -> 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.DescribeEntityRecognizer" ::
                          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 DescribeEntityRecognizer where
  toJSON :: DescribeEntityRecognizer -> Value
toJSON DescribeEntityRecognizer' {Text
entityRecognizerArn :: Text
$sel:entityRecognizerArn:DescribeEntityRecognizer' :: DescribeEntityRecognizer -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just
              (Key
"EntityRecognizerArn" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
entityRecognizerArn)
          ]
      )

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

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

-- | /See:/ 'newDescribeEntityRecognizerResponse' smart constructor.
data DescribeEntityRecognizerResponse = DescribeEntityRecognizerResponse'
  { -- | Describes information associated with an entity recognizer.
    DescribeEntityRecognizerResponse
-> Maybe EntityRecognizerProperties
entityRecognizerProperties :: Prelude.Maybe EntityRecognizerProperties,
    -- | The response's http status code.
    DescribeEntityRecognizerResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeEntityRecognizerResponse
-> DescribeEntityRecognizerResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeEntityRecognizerResponse
-> DescribeEntityRecognizerResponse -> Bool
$c/= :: DescribeEntityRecognizerResponse
-> DescribeEntityRecognizerResponse -> Bool
== :: DescribeEntityRecognizerResponse
-> DescribeEntityRecognizerResponse -> Bool
$c== :: DescribeEntityRecognizerResponse
-> DescribeEntityRecognizerResponse -> Bool
Prelude.Eq, Int -> DescribeEntityRecognizerResponse -> ShowS
[DescribeEntityRecognizerResponse] -> ShowS
DescribeEntityRecognizerResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeEntityRecognizerResponse] -> ShowS
$cshowList :: [DescribeEntityRecognizerResponse] -> ShowS
show :: DescribeEntityRecognizerResponse -> String
$cshow :: DescribeEntityRecognizerResponse -> String
showsPrec :: Int -> DescribeEntityRecognizerResponse -> ShowS
$cshowsPrec :: Int -> DescribeEntityRecognizerResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeEntityRecognizerResponse x
-> DescribeEntityRecognizerResponse
forall x.
DescribeEntityRecognizerResponse
-> Rep DescribeEntityRecognizerResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeEntityRecognizerResponse x
-> DescribeEntityRecognizerResponse
$cfrom :: forall x.
DescribeEntityRecognizerResponse
-> Rep DescribeEntityRecognizerResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeEntityRecognizerResponse' 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:
--
-- 'entityRecognizerProperties', 'describeEntityRecognizerResponse_entityRecognizerProperties' - Describes information associated with an entity recognizer.
--
-- 'httpStatus', 'describeEntityRecognizerResponse_httpStatus' - The response's http status code.
newDescribeEntityRecognizerResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeEntityRecognizerResponse
newDescribeEntityRecognizerResponse :: Int -> DescribeEntityRecognizerResponse
newDescribeEntityRecognizerResponse Int
pHttpStatus_ =
  DescribeEntityRecognizerResponse'
    { $sel:entityRecognizerProperties:DescribeEntityRecognizerResponse' :: Maybe EntityRecognizerProperties
entityRecognizerProperties =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeEntityRecognizerResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Describes information associated with an entity recognizer.
describeEntityRecognizerResponse_entityRecognizerProperties :: Lens.Lens' DescribeEntityRecognizerResponse (Prelude.Maybe EntityRecognizerProperties)
describeEntityRecognizerResponse_entityRecognizerProperties :: Lens'
  DescribeEntityRecognizerResponse (Maybe EntityRecognizerProperties)
describeEntityRecognizerResponse_entityRecognizerProperties = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEntityRecognizerResponse' {Maybe EntityRecognizerProperties
entityRecognizerProperties :: Maybe EntityRecognizerProperties
$sel:entityRecognizerProperties:DescribeEntityRecognizerResponse' :: DescribeEntityRecognizerResponse
-> Maybe EntityRecognizerProperties
entityRecognizerProperties} -> Maybe EntityRecognizerProperties
entityRecognizerProperties) (\s :: DescribeEntityRecognizerResponse
s@DescribeEntityRecognizerResponse' {} Maybe EntityRecognizerProperties
a -> DescribeEntityRecognizerResponse
s {$sel:entityRecognizerProperties:DescribeEntityRecognizerResponse' :: Maybe EntityRecognizerProperties
entityRecognizerProperties = Maybe EntityRecognizerProperties
a} :: DescribeEntityRecognizerResponse)

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

instance
  Prelude.NFData
    DescribeEntityRecognizerResponse
  where
  rnf :: DescribeEntityRecognizerResponse -> ()
rnf DescribeEntityRecognizerResponse' {Int
Maybe EntityRecognizerProperties
httpStatus :: Int
entityRecognizerProperties :: Maybe EntityRecognizerProperties
$sel:httpStatus:DescribeEntityRecognizerResponse' :: DescribeEntityRecognizerResponse -> Int
$sel:entityRecognizerProperties:DescribeEntityRecognizerResponse' :: DescribeEntityRecognizerResponse
-> Maybe EntityRecognizerProperties
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe EntityRecognizerProperties
entityRecognizerProperties
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus