{-# 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.Personalize.DescribeFilter
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes a filter\'s properties.
module Amazonka.Personalize.DescribeFilter
  ( -- * Creating a Request
    DescribeFilter (..),
    newDescribeFilter,

    -- * Request Lenses
    describeFilter_filterArn,

    -- * Destructuring the Response
    DescribeFilterResponse (..),
    newDescribeFilterResponse,

    -- * Response Lenses
    describeFilterResponse_filter,
    describeFilterResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeFilter' smart constructor.
data DescribeFilter = DescribeFilter'
  { -- | The ARN of the filter to describe.
    DescribeFilter -> Text
filterArn :: Prelude.Text
  }
  deriving (DescribeFilter -> DescribeFilter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeFilter -> DescribeFilter -> Bool
$c/= :: DescribeFilter -> DescribeFilter -> Bool
== :: DescribeFilter -> DescribeFilter -> Bool
$c== :: DescribeFilter -> DescribeFilter -> Bool
Prelude.Eq, ReadPrec [DescribeFilter]
ReadPrec DescribeFilter
Int -> ReadS DescribeFilter
ReadS [DescribeFilter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeFilter]
$creadListPrec :: ReadPrec [DescribeFilter]
readPrec :: ReadPrec DescribeFilter
$creadPrec :: ReadPrec DescribeFilter
readList :: ReadS [DescribeFilter]
$creadList :: ReadS [DescribeFilter]
readsPrec :: Int -> ReadS DescribeFilter
$creadsPrec :: Int -> ReadS DescribeFilter
Prelude.Read, Int -> DescribeFilter -> ShowS
[DescribeFilter] -> ShowS
DescribeFilter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeFilter] -> ShowS
$cshowList :: [DescribeFilter] -> ShowS
show :: DescribeFilter -> String
$cshow :: DescribeFilter -> String
showsPrec :: Int -> DescribeFilter -> ShowS
$cshowsPrec :: Int -> DescribeFilter -> ShowS
Prelude.Show, forall x. Rep DescribeFilter x -> DescribeFilter
forall x. DescribeFilter -> Rep DescribeFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeFilter x -> DescribeFilter
$cfrom :: forall x. DescribeFilter -> Rep DescribeFilter x
Prelude.Generic)

-- |
-- Create a value of 'DescribeFilter' 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:
--
-- 'filterArn', 'describeFilter_filterArn' - The ARN of the filter to describe.
newDescribeFilter ::
  -- | 'filterArn'
  Prelude.Text ->
  DescribeFilter
newDescribeFilter :: Text -> DescribeFilter
newDescribeFilter Text
pFilterArn_ =
  DescribeFilter' {$sel:filterArn:DescribeFilter' :: Text
filterArn = Text
pFilterArn_}

-- | The ARN of the filter to describe.
describeFilter_filterArn :: Lens.Lens' DescribeFilter Prelude.Text
describeFilter_filterArn :: Lens' DescribeFilter Text
describeFilter_filterArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFilter' {Text
filterArn :: Text
$sel:filterArn:DescribeFilter' :: DescribeFilter -> Text
filterArn} -> Text
filterArn) (\s :: DescribeFilter
s@DescribeFilter' {} Text
a -> DescribeFilter
s {$sel:filterArn:DescribeFilter' :: Text
filterArn = Text
a} :: DescribeFilter)

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

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

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

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

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

-- | /See:/ 'newDescribeFilterResponse' smart constructor.
data DescribeFilterResponse = DescribeFilterResponse'
  { -- | The filter\'s details.
    DescribeFilterResponse -> Maybe Filter
filter' :: Prelude.Maybe Filter,
    -- | The response's http status code.
    DescribeFilterResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeFilterResponse -> DescribeFilterResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeFilterResponse -> DescribeFilterResponse -> Bool
$c/= :: DescribeFilterResponse -> DescribeFilterResponse -> Bool
== :: DescribeFilterResponse -> DescribeFilterResponse -> Bool
$c== :: DescribeFilterResponse -> DescribeFilterResponse -> Bool
Prelude.Eq, Int -> DescribeFilterResponse -> ShowS
[DescribeFilterResponse] -> ShowS
DescribeFilterResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeFilterResponse] -> ShowS
$cshowList :: [DescribeFilterResponse] -> ShowS
show :: DescribeFilterResponse -> String
$cshow :: DescribeFilterResponse -> String
showsPrec :: Int -> DescribeFilterResponse -> ShowS
$cshowsPrec :: Int -> DescribeFilterResponse -> ShowS
Prelude.Show, forall x. Rep DescribeFilterResponse x -> DescribeFilterResponse
forall x. DescribeFilterResponse -> Rep DescribeFilterResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeFilterResponse x -> DescribeFilterResponse
$cfrom :: forall x. DescribeFilterResponse -> Rep DescribeFilterResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeFilterResponse' 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:
--
-- 'filter'', 'describeFilterResponse_filter' - The filter\'s details.
--
-- 'httpStatus', 'describeFilterResponse_httpStatus' - The response's http status code.
newDescribeFilterResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeFilterResponse
newDescribeFilterResponse :: Int -> DescribeFilterResponse
newDescribeFilterResponse Int
pHttpStatus_ =
  DescribeFilterResponse'
    { $sel:filter':DescribeFilterResponse' :: Maybe Filter
filter' = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeFilterResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The filter\'s details.
describeFilterResponse_filter :: Lens.Lens' DescribeFilterResponse (Prelude.Maybe Filter)
describeFilterResponse_filter :: Lens' DescribeFilterResponse (Maybe Filter)
describeFilterResponse_filter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFilterResponse' {Maybe Filter
filter' :: Maybe Filter
$sel:filter':DescribeFilterResponse' :: DescribeFilterResponse -> Maybe Filter
filter'} -> Maybe Filter
filter') (\s :: DescribeFilterResponse
s@DescribeFilterResponse' {} Maybe Filter
a -> DescribeFilterResponse
s {$sel:filter':DescribeFilterResponse' :: Maybe Filter
filter' = Maybe Filter
a} :: DescribeFilterResponse)

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

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