{-# 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.IoT.DescribeAuditFinding
-- 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 information about a single audit finding. Properties include the
-- reason for noncompliance, the severity of the issue, and the start time
-- when the audit that returned the finding.
--
-- Requires permission to access the
-- <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions DescribeAuditFinding>
-- action.
module Amazonka.IoT.DescribeAuditFinding
  ( -- * Creating a Request
    DescribeAuditFinding (..),
    newDescribeAuditFinding,

    -- * Request Lenses
    describeAuditFinding_findingId,

    -- * Destructuring the Response
    DescribeAuditFindingResponse (..),
    newDescribeAuditFindingResponse,

    -- * Response Lenses
    describeAuditFindingResponse_finding,
    describeAuditFindingResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeAuditFinding' smart constructor.
data DescribeAuditFinding = DescribeAuditFinding'
  { -- | A unique identifier for a single audit finding. You can use this
    -- identifier to apply mitigation actions to the finding.
    DescribeAuditFinding -> Text
findingId :: Prelude.Text
  }
  deriving (DescribeAuditFinding -> DescribeAuditFinding -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeAuditFinding -> DescribeAuditFinding -> Bool
$c/= :: DescribeAuditFinding -> DescribeAuditFinding -> Bool
== :: DescribeAuditFinding -> DescribeAuditFinding -> Bool
$c== :: DescribeAuditFinding -> DescribeAuditFinding -> Bool
Prelude.Eq, ReadPrec [DescribeAuditFinding]
ReadPrec DescribeAuditFinding
Int -> ReadS DescribeAuditFinding
ReadS [DescribeAuditFinding]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeAuditFinding]
$creadListPrec :: ReadPrec [DescribeAuditFinding]
readPrec :: ReadPrec DescribeAuditFinding
$creadPrec :: ReadPrec DescribeAuditFinding
readList :: ReadS [DescribeAuditFinding]
$creadList :: ReadS [DescribeAuditFinding]
readsPrec :: Int -> ReadS DescribeAuditFinding
$creadsPrec :: Int -> ReadS DescribeAuditFinding
Prelude.Read, Int -> DescribeAuditFinding -> ShowS
[DescribeAuditFinding] -> ShowS
DescribeAuditFinding -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeAuditFinding] -> ShowS
$cshowList :: [DescribeAuditFinding] -> ShowS
show :: DescribeAuditFinding -> String
$cshow :: DescribeAuditFinding -> String
showsPrec :: Int -> DescribeAuditFinding -> ShowS
$cshowsPrec :: Int -> DescribeAuditFinding -> ShowS
Prelude.Show, forall x. Rep DescribeAuditFinding x -> DescribeAuditFinding
forall x. DescribeAuditFinding -> Rep DescribeAuditFinding x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeAuditFinding x -> DescribeAuditFinding
$cfrom :: forall x. DescribeAuditFinding -> Rep DescribeAuditFinding x
Prelude.Generic)

-- |
-- Create a value of 'DescribeAuditFinding' 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:
--
-- 'findingId', 'describeAuditFinding_findingId' - A unique identifier for a single audit finding. You can use this
-- identifier to apply mitigation actions to the finding.
newDescribeAuditFinding ::
  -- | 'findingId'
  Prelude.Text ->
  DescribeAuditFinding
newDescribeAuditFinding :: Text -> DescribeAuditFinding
newDescribeAuditFinding Text
pFindingId_ =
  DescribeAuditFinding' {$sel:findingId:DescribeAuditFinding' :: Text
findingId = Text
pFindingId_}

-- | A unique identifier for a single audit finding. You can use this
-- identifier to apply mitigation actions to the finding.
describeAuditFinding_findingId :: Lens.Lens' DescribeAuditFinding Prelude.Text
describeAuditFinding_findingId :: Lens' DescribeAuditFinding Text
describeAuditFinding_findingId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeAuditFinding' {Text
findingId :: Text
$sel:findingId:DescribeAuditFinding' :: DescribeAuditFinding -> Text
findingId} -> Text
findingId) (\s :: DescribeAuditFinding
s@DescribeAuditFinding' {} Text
a -> DescribeAuditFinding
s {$sel:findingId:DescribeAuditFinding' :: Text
findingId = Text
a} :: DescribeAuditFinding)

instance Core.AWSRequest DescribeAuditFinding where
  type
    AWSResponse DescribeAuditFinding =
      DescribeAuditFindingResponse
  request :: (Service -> Service)
-> DescribeAuditFinding -> Request DescribeAuditFinding
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribeAuditFinding
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeAuditFinding)))
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 AuditFinding -> Int -> DescribeAuditFindingResponse
DescribeAuditFindingResponse'
            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
"finding")
            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 DescribeAuditFinding where
  hashWithSalt :: Int -> DescribeAuditFinding -> Int
hashWithSalt Int
_salt DescribeAuditFinding' {Text
findingId :: Text
$sel:findingId:DescribeAuditFinding' :: DescribeAuditFinding -> Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
findingId

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

instance Data.ToHeaders DescribeAuditFinding where
  toHeaders :: DescribeAuditFinding -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

instance Data.ToPath DescribeAuditFinding where
  toPath :: DescribeAuditFinding -> ByteString
toPath DescribeAuditFinding' {Text
findingId :: Text
$sel:findingId:DescribeAuditFinding' :: DescribeAuditFinding -> Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"/audit/findings/", forall a. ToByteString a => a -> ByteString
Data.toBS Text
findingId]

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

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

-- |
-- Create a value of 'DescribeAuditFindingResponse' 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:
--
-- 'finding', 'describeAuditFindingResponse_finding' - Undocumented member.
--
-- 'httpStatus', 'describeAuditFindingResponse_httpStatus' - The response's http status code.
newDescribeAuditFindingResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeAuditFindingResponse
newDescribeAuditFindingResponse :: Int -> DescribeAuditFindingResponse
newDescribeAuditFindingResponse Int
pHttpStatus_ =
  DescribeAuditFindingResponse'
    { $sel:finding:DescribeAuditFindingResponse' :: Maybe AuditFinding
finding =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeAuditFindingResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Undocumented member.
describeAuditFindingResponse_finding :: Lens.Lens' DescribeAuditFindingResponse (Prelude.Maybe AuditFinding)
describeAuditFindingResponse_finding :: Lens' DescribeAuditFindingResponse (Maybe AuditFinding)
describeAuditFindingResponse_finding = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeAuditFindingResponse' {Maybe AuditFinding
finding :: Maybe AuditFinding
$sel:finding:DescribeAuditFindingResponse' :: DescribeAuditFindingResponse -> Maybe AuditFinding
finding} -> Maybe AuditFinding
finding) (\s :: DescribeAuditFindingResponse
s@DescribeAuditFindingResponse' {} Maybe AuditFinding
a -> DescribeAuditFindingResponse
s {$sel:finding:DescribeAuditFindingResponse' :: Maybe AuditFinding
finding = Maybe AuditFinding
a} :: DescribeAuditFindingResponse)

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

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