{-# 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.ComprehendMedical.DescribeEntitiesDetectionV2Job
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Gets the properties associated with a medical entities detection job.
-- Use this operation to get the status of a detection job.
module Amazonka.ComprehendMedical.DescribeEntitiesDetectionV2Job
  ( -- * Creating a Request
    DescribeEntitiesDetectionV2Job (..),
    newDescribeEntitiesDetectionV2Job,

    -- * Request Lenses
    describeEntitiesDetectionV2Job_jobId,

    -- * Destructuring the Response
    DescribeEntitiesDetectionV2JobResponse (..),
    newDescribeEntitiesDetectionV2JobResponse,

    -- * Response Lenses
    describeEntitiesDetectionV2JobResponse_comprehendMedicalAsyncJobProperties,
    describeEntitiesDetectionV2JobResponse_httpStatus,
  )
where

import Amazonka.ComprehendMedical.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:/ 'newDescribeEntitiesDetectionV2Job' smart constructor.
data DescribeEntitiesDetectionV2Job = DescribeEntitiesDetectionV2Job'
  { -- | The identifier that Comprehend Medical; generated for the job. The
    -- @StartEntitiesDetectionV2Job@ operation returns this identifier in its
    -- response.
    DescribeEntitiesDetectionV2Job -> Text
jobId :: Prelude.Text
  }
  deriving (DescribeEntitiesDetectionV2Job
-> DescribeEntitiesDetectionV2Job -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeEntitiesDetectionV2Job
-> DescribeEntitiesDetectionV2Job -> Bool
$c/= :: DescribeEntitiesDetectionV2Job
-> DescribeEntitiesDetectionV2Job -> Bool
== :: DescribeEntitiesDetectionV2Job
-> DescribeEntitiesDetectionV2Job -> Bool
$c== :: DescribeEntitiesDetectionV2Job
-> DescribeEntitiesDetectionV2Job -> Bool
Prelude.Eq, ReadPrec [DescribeEntitiesDetectionV2Job]
ReadPrec DescribeEntitiesDetectionV2Job
Int -> ReadS DescribeEntitiesDetectionV2Job
ReadS [DescribeEntitiesDetectionV2Job]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeEntitiesDetectionV2Job]
$creadListPrec :: ReadPrec [DescribeEntitiesDetectionV2Job]
readPrec :: ReadPrec DescribeEntitiesDetectionV2Job
$creadPrec :: ReadPrec DescribeEntitiesDetectionV2Job
readList :: ReadS [DescribeEntitiesDetectionV2Job]
$creadList :: ReadS [DescribeEntitiesDetectionV2Job]
readsPrec :: Int -> ReadS DescribeEntitiesDetectionV2Job
$creadsPrec :: Int -> ReadS DescribeEntitiesDetectionV2Job
Prelude.Read, Int -> DescribeEntitiesDetectionV2Job -> ShowS
[DescribeEntitiesDetectionV2Job] -> ShowS
DescribeEntitiesDetectionV2Job -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeEntitiesDetectionV2Job] -> ShowS
$cshowList :: [DescribeEntitiesDetectionV2Job] -> ShowS
show :: DescribeEntitiesDetectionV2Job -> String
$cshow :: DescribeEntitiesDetectionV2Job -> String
showsPrec :: Int -> DescribeEntitiesDetectionV2Job -> ShowS
$cshowsPrec :: Int -> DescribeEntitiesDetectionV2Job -> ShowS
Prelude.Show, forall x.
Rep DescribeEntitiesDetectionV2Job x
-> DescribeEntitiesDetectionV2Job
forall x.
DescribeEntitiesDetectionV2Job
-> Rep DescribeEntitiesDetectionV2Job x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeEntitiesDetectionV2Job x
-> DescribeEntitiesDetectionV2Job
$cfrom :: forall x.
DescribeEntitiesDetectionV2Job
-> Rep DescribeEntitiesDetectionV2Job x
Prelude.Generic)

-- |
-- Create a value of 'DescribeEntitiesDetectionV2Job' 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:
--
-- 'jobId', 'describeEntitiesDetectionV2Job_jobId' - The identifier that Comprehend Medical; generated for the job. The
-- @StartEntitiesDetectionV2Job@ operation returns this identifier in its
-- response.
newDescribeEntitiesDetectionV2Job ::
  -- | 'jobId'
  Prelude.Text ->
  DescribeEntitiesDetectionV2Job
newDescribeEntitiesDetectionV2Job :: Text -> DescribeEntitiesDetectionV2Job
newDescribeEntitiesDetectionV2Job Text
pJobId_ =
  DescribeEntitiesDetectionV2Job' {$sel:jobId:DescribeEntitiesDetectionV2Job' :: Text
jobId = Text
pJobId_}

-- | The identifier that Comprehend Medical; generated for the job. The
-- @StartEntitiesDetectionV2Job@ operation returns this identifier in its
-- response.
describeEntitiesDetectionV2Job_jobId :: Lens.Lens' DescribeEntitiesDetectionV2Job Prelude.Text
describeEntitiesDetectionV2Job_jobId :: Lens' DescribeEntitiesDetectionV2Job Text
describeEntitiesDetectionV2Job_jobId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEntitiesDetectionV2Job' {Text
jobId :: Text
$sel:jobId:DescribeEntitiesDetectionV2Job' :: DescribeEntitiesDetectionV2Job -> Text
jobId} -> Text
jobId) (\s :: DescribeEntitiesDetectionV2Job
s@DescribeEntitiesDetectionV2Job' {} Text
a -> DescribeEntitiesDetectionV2Job
s {$sel:jobId:DescribeEntitiesDetectionV2Job' :: Text
jobId = Text
a} :: DescribeEntitiesDetectionV2Job)

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

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

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

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

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

-- | /See:/ 'newDescribeEntitiesDetectionV2JobResponse' smart constructor.
data DescribeEntitiesDetectionV2JobResponse = DescribeEntitiesDetectionV2JobResponse'
  { -- | An object that contains the properties associated with a detection job.
    DescribeEntitiesDetectionV2JobResponse
-> Maybe ComprehendMedicalAsyncJobProperties
comprehendMedicalAsyncJobProperties :: Prelude.Maybe ComprehendMedicalAsyncJobProperties,
    -- | The response's http status code.
    DescribeEntitiesDetectionV2JobResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeEntitiesDetectionV2JobResponse
-> DescribeEntitiesDetectionV2JobResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeEntitiesDetectionV2JobResponse
-> DescribeEntitiesDetectionV2JobResponse -> Bool
$c/= :: DescribeEntitiesDetectionV2JobResponse
-> DescribeEntitiesDetectionV2JobResponse -> Bool
== :: DescribeEntitiesDetectionV2JobResponse
-> DescribeEntitiesDetectionV2JobResponse -> Bool
$c== :: DescribeEntitiesDetectionV2JobResponse
-> DescribeEntitiesDetectionV2JobResponse -> Bool
Prelude.Eq, ReadPrec [DescribeEntitiesDetectionV2JobResponse]
ReadPrec DescribeEntitiesDetectionV2JobResponse
Int -> ReadS DescribeEntitiesDetectionV2JobResponse
ReadS [DescribeEntitiesDetectionV2JobResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeEntitiesDetectionV2JobResponse]
$creadListPrec :: ReadPrec [DescribeEntitiesDetectionV2JobResponse]
readPrec :: ReadPrec DescribeEntitiesDetectionV2JobResponse
$creadPrec :: ReadPrec DescribeEntitiesDetectionV2JobResponse
readList :: ReadS [DescribeEntitiesDetectionV2JobResponse]
$creadList :: ReadS [DescribeEntitiesDetectionV2JobResponse]
readsPrec :: Int -> ReadS DescribeEntitiesDetectionV2JobResponse
$creadsPrec :: Int -> ReadS DescribeEntitiesDetectionV2JobResponse
Prelude.Read, Int -> DescribeEntitiesDetectionV2JobResponse -> ShowS
[DescribeEntitiesDetectionV2JobResponse] -> ShowS
DescribeEntitiesDetectionV2JobResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeEntitiesDetectionV2JobResponse] -> ShowS
$cshowList :: [DescribeEntitiesDetectionV2JobResponse] -> ShowS
show :: DescribeEntitiesDetectionV2JobResponse -> String
$cshow :: DescribeEntitiesDetectionV2JobResponse -> String
showsPrec :: Int -> DescribeEntitiesDetectionV2JobResponse -> ShowS
$cshowsPrec :: Int -> DescribeEntitiesDetectionV2JobResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeEntitiesDetectionV2JobResponse x
-> DescribeEntitiesDetectionV2JobResponse
forall x.
DescribeEntitiesDetectionV2JobResponse
-> Rep DescribeEntitiesDetectionV2JobResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeEntitiesDetectionV2JobResponse x
-> DescribeEntitiesDetectionV2JobResponse
$cfrom :: forall x.
DescribeEntitiesDetectionV2JobResponse
-> Rep DescribeEntitiesDetectionV2JobResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeEntitiesDetectionV2JobResponse' 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:
--
-- 'comprehendMedicalAsyncJobProperties', 'describeEntitiesDetectionV2JobResponse_comprehendMedicalAsyncJobProperties' - An object that contains the properties associated with a detection job.
--
-- 'httpStatus', 'describeEntitiesDetectionV2JobResponse_httpStatus' - The response's http status code.
newDescribeEntitiesDetectionV2JobResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeEntitiesDetectionV2JobResponse
newDescribeEntitiesDetectionV2JobResponse :: Int -> DescribeEntitiesDetectionV2JobResponse
newDescribeEntitiesDetectionV2JobResponse
  Int
pHttpStatus_ =
    DescribeEntitiesDetectionV2JobResponse'
      { $sel:comprehendMedicalAsyncJobProperties:DescribeEntitiesDetectionV2JobResponse' :: Maybe ComprehendMedicalAsyncJobProperties
comprehendMedicalAsyncJobProperties =
          forall a. Maybe a
Prelude.Nothing,
        $sel:httpStatus:DescribeEntitiesDetectionV2JobResponse' :: Int
httpStatus = Int
pHttpStatus_
      }

-- | An object that contains the properties associated with a detection job.
describeEntitiesDetectionV2JobResponse_comprehendMedicalAsyncJobProperties :: Lens.Lens' DescribeEntitiesDetectionV2JobResponse (Prelude.Maybe ComprehendMedicalAsyncJobProperties)
describeEntitiesDetectionV2JobResponse_comprehendMedicalAsyncJobProperties :: Lens'
  DescribeEntitiesDetectionV2JobResponse
  (Maybe ComprehendMedicalAsyncJobProperties)
describeEntitiesDetectionV2JobResponse_comprehendMedicalAsyncJobProperties = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEntitiesDetectionV2JobResponse' {Maybe ComprehendMedicalAsyncJobProperties
comprehendMedicalAsyncJobProperties :: Maybe ComprehendMedicalAsyncJobProperties
$sel:comprehendMedicalAsyncJobProperties:DescribeEntitiesDetectionV2JobResponse' :: DescribeEntitiesDetectionV2JobResponse
-> Maybe ComprehendMedicalAsyncJobProperties
comprehendMedicalAsyncJobProperties} -> Maybe ComprehendMedicalAsyncJobProperties
comprehendMedicalAsyncJobProperties) (\s :: DescribeEntitiesDetectionV2JobResponse
s@DescribeEntitiesDetectionV2JobResponse' {} Maybe ComprehendMedicalAsyncJobProperties
a -> DescribeEntitiesDetectionV2JobResponse
s {$sel:comprehendMedicalAsyncJobProperties:DescribeEntitiesDetectionV2JobResponse' :: Maybe ComprehendMedicalAsyncJobProperties
comprehendMedicalAsyncJobProperties = Maybe ComprehendMedicalAsyncJobProperties
a} :: DescribeEntitiesDetectionV2JobResponse)

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

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