{-# 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.SSM.GetParameters
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Get information about one or more parameters by specifying multiple
-- parameter names.
--
-- To get information about a single parameter, you can use the
-- GetParameter operation instead.
module Amazonka.SSM.GetParameters
  ( -- * Creating a Request
    GetParameters (..),
    newGetParameters,

    -- * Request Lenses
    getParameters_withDecryption,
    getParameters_names,

    -- * Destructuring the Response
    GetParametersResponse (..),
    newGetParametersResponse,

    -- * Response Lenses
    getParametersResponse_httpStatus,
    getParametersResponse_invalidParameters,
    getParametersResponse_parameters,
  )
where

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
import Amazonka.SSM.Types

-- | /See:/ 'newGetParameters' smart constructor.
data GetParameters = GetParameters'
  { -- | Return decrypted secure string value. Return decrypted values for secure
    -- string parameters. This flag is ignored for @String@ and @StringList@
    -- parameter types.
    GetParameters -> Maybe Bool
withDecryption :: Prelude.Maybe Prelude.Bool,
    -- | Names of the parameters for which you want to query information.
    --
    -- To query by parameter label, use @\"Name\": \"name:label\"@. To query by
    -- parameter version, use @\"Name\": \"name:version\"@.
    GetParameters -> NonEmpty Text
names :: Prelude.NonEmpty Prelude.Text
  }
  deriving (GetParameters -> GetParameters -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetParameters -> GetParameters -> Bool
$c/= :: GetParameters -> GetParameters -> Bool
== :: GetParameters -> GetParameters -> Bool
$c== :: GetParameters -> GetParameters -> Bool
Prelude.Eq, ReadPrec [GetParameters]
ReadPrec GetParameters
Int -> ReadS GetParameters
ReadS [GetParameters]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetParameters]
$creadListPrec :: ReadPrec [GetParameters]
readPrec :: ReadPrec GetParameters
$creadPrec :: ReadPrec GetParameters
readList :: ReadS [GetParameters]
$creadList :: ReadS [GetParameters]
readsPrec :: Int -> ReadS GetParameters
$creadsPrec :: Int -> ReadS GetParameters
Prelude.Read, Int -> GetParameters -> ShowS
[GetParameters] -> ShowS
GetParameters -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetParameters] -> ShowS
$cshowList :: [GetParameters] -> ShowS
show :: GetParameters -> String
$cshow :: GetParameters -> String
showsPrec :: Int -> GetParameters -> ShowS
$cshowsPrec :: Int -> GetParameters -> ShowS
Prelude.Show, forall x. Rep GetParameters x -> GetParameters
forall x. GetParameters -> Rep GetParameters x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetParameters x -> GetParameters
$cfrom :: forall x. GetParameters -> Rep GetParameters x
Prelude.Generic)

-- |
-- Create a value of 'GetParameters' 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:
--
-- 'withDecryption', 'getParameters_withDecryption' - Return decrypted secure string value. Return decrypted values for secure
-- string parameters. This flag is ignored for @String@ and @StringList@
-- parameter types.
--
-- 'names', 'getParameters_names' - Names of the parameters for which you want to query information.
--
-- To query by parameter label, use @\"Name\": \"name:label\"@. To query by
-- parameter version, use @\"Name\": \"name:version\"@.
newGetParameters ::
  -- | 'names'
  Prelude.NonEmpty Prelude.Text ->
  GetParameters
newGetParameters :: NonEmpty Text -> GetParameters
newGetParameters NonEmpty Text
pNames_ =
  GetParameters'
    { $sel:withDecryption:GetParameters' :: Maybe Bool
withDecryption = forall a. Maybe a
Prelude.Nothing,
      $sel:names:GetParameters' :: NonEmpty Text
names = forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced forall t b. AReview t b -> b -> t
Lens.# NonEmpty Text
pNames_
    }

-- | Return decrypted secure string value. Return decrypted values for secure
-- string parameters. This flag is ignored for @String@ and @StringList@
-- parameter types.
getParameters_withDecryption :: Lens.Lens' GetParameters (Prelude.Maybe Prelude.Bool)
getParameters_withDecryption :: Lens' GetParameters (Maybe Bool)
getParameters_withDecryption = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetParameters' {Maybe Bool
withDecryption :: Maybe Bool
$sel:withDecryption:GetParameters' :: GetParameters -> Maybe Bool
withDecryption} -> Maybe Bool
withDecryption) (\s :: GetParameters
s@GetParameters' {} Maybe Bool
a -> GetParameters
s {$sel:withDecryption:GetParameters' :: Maybe Bool
withDecryption = Maybe Bool
a} :: GetParameters)

-- | Names of the parameters for which you want to query information.
--
-- To query by parameter label, use @\"Name\": \"name:label\"@. To query by
-- parameter version, use @\"Name\": \"name:version\"@.
getParameters_names :: Lens.Lens' GetParameters (Prelude.NonEmpty Prelude.Text)
getParameters_names :: Lens' GetParameters (NonEmpty Text)
getParameters_names = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetParameters' {NonEmpty Text
names :: NonEmpty Text
$sel:names:GetParameters' :: GetParameters -> NonEmpty Text
names} -> NonEmpty Text
names) (\s :: GetParameters
s@GetParameters' {} NonEmpty Text
a -> GetParameters
s {$sel:names:GetParameters' :: NonEmpty Text
names = NonEmpty Text
a} :: GetParameters) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.AWSRequest GetParameters where
  type
    AWSResponse GetParameters =
      GetParametersResponse
  request :: (Service -> Service) -> GetParameters -> Request GetParameters
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 GetParameters
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetParameters)))
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 ->
          Int -> [Text] -> [Parameter] -> GetParametersResponse
GetParametersResponse'
            forall (f :: * -> *) a b. Functor 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))
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"InvalidParameters"
                            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.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Parameters" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable GetParameters where
  hashWithSalt :: Int -> GetParameters -> Int
hashWithSalt Int
_salt GetParameters' {Maybe Bool
NonEmpty Text
names :: NonEmpty Text
withDecryption :: Maybe Bool
$sel:names:GetParameters' :: GetParameters -> NonEmpty Text
$sel:withDecryption:GetParameters' :: GetParameters -> Maybe Bool
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
withDecryption
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` NonEmpty Text
names

instance Prelude.NFData GetParameters where
  rnf :: GetParameters -> ()
rnf GetParameters' {Maybe Bool
NonEmpty Text
names :: NonEmpty Text
withDecryption :: Maybe Bool
$sel:names:GetParameters' :: GetParameters -> NonEmpty Text
$sel:withDecryption:GetParameters' :: GetParameters -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
withDecryption
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf NonEmpty Text
names

instance Data.ToHeaders GetParameters where
  toHeaders :: GetParameters -> 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
"AmazonSSM.GetParameters" :: 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 GetParameters where
  toJSON :: GetParameters -> Value
toJSON GetParameters' {Maybe Bool
NonEmpty Text
names :: NonEmpty Text
withDecryption :: Maybe Bool
$sel:names:GetParameters' :: GetParameters -> NonEmpty Text
$sel:withDecryption:GetParameters' :: GetParameters -> Maybe Bool
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"WithDecryption" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
withDecryption,
            forall a. a -> Maybe a
Prelude.Just (Key
"Names" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= NonEmpty Text
names)
          ]
      )

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

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

-- | /See:/ 'newGetParametersResponse' smart constructor.
data GetParametersResponse = GetParametersResponse'
  { -- | The response's http status code.
    GetParametersResponse -> Int
httpStatus :: Prelude.Int,
    -- | A list of parameters that aren\'t formatted correctly or don\'t run
    -- during an execution.
    GetParametersResponse -> [Text]
invalidParameters :: [Prelude.Text],
    -- | A list of details for a parameter.
    GetParametersResponse -> [Parameter]
parameters :: [Parameter]
  }
  deriving (GetParametersResponse -> GetParametersResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetParametersResponse -> GetParametersResponse -> Bool
$c/= :: GetParametersResponse -> GetParametersResponse -> Bool
== :: GetParametersResponse -> GetParametersResponse -> Bool
$c== :: GetParametersResponse -> GetParametersResponse -> Bool
Prelude.Eq, Int -> GetParametersResponse -> ShowS
[GetParametersResponse] -> ShowS
GetParametersResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetParametersResponse] -> ShowS
$cshowList :: [GetParametersResponse] -> ShowS
show :: GetParametersResponse -> String
$cshow :: GetParametersResponse -> String
showsPrec :: Int -> GetParametersResponse -> ShowS
$cshowsPrec :: Int -> GetParametersResponse -> ShowS
Prelude.Show, forall x. Rep GetParametersResponse x -> GetParametersResponse
forall x. GetParametersResponse -> Rep GetParametersResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetParametersResponse x -> GetParametersResponse
$cfrom :: forall x. GetParametersResponse -> Rep GetParametersResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetParametersResponse' 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:
--
-- 'httpStatus', 'getParametersResponse_httpStatus' - The response's http status code.
--
-- 'invalidParameters', 'getParametersResponse_invalidParameters' - A list of parameters that aren\'t formatted correctly or don\'t run
-- during an execution.
--
-- 'parameters', 'getParametersResponse_parameters' - A list of details for a parameter.
newGetParametersResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetParametersResponse
newGetParametersResponse :: Int -> GetParametersResponse
newGetParametersResponse Int
pHttpStatus_ =
  GetParametersResponse'
    { $sel:httpStatus:GetParametersResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:invalidParameters:GetParametersResponse' :: [Text]
invalidParameters = forall a. Monoid a => a
Prelude.mempty,
      $sel:parameters:GetParametersResponse' :: [Parameter]
parameters = forall a. Monoid a => a
Prelude.mempty
    }

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

-- | A list of parameters that aren\'t formatted correctly or don\'t run
-- during an execution.
getParametersResponse_invalidParameters :: Lens.Lens' GetParametersResponse [Prelude.Text]
getParametersResponse_invalidParameters :: Lens' GetParametersResponse [Text]
getParametersResponse_invalidParameters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetParametersResponse' {[Text]
invalidParameters :: [Text]
$sel:invalidParameters:GetParametersResponse' :: GetParametersResponse -> [Text]
invalidParameters} -> [Text]
invalidParameters) (\s :: GetParametersResponse
s@GetParametersResponse' {} [Text]
a -> GetParametersResponse
s {$sel:invalidParameters:GetParametersResponse' :: [Text]
invalidParameters = [Text]
a} :: GetParametersResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A list of details for a parameter.
getParametersResponse_parameters :: Lens.Lens' GetParametersResponse [Parameter]
getParametersResponse_parameters :: Lens' GetParametersResponse [Parameter]
getParametersResponse_parameters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetParametersResponse' {[Parameter]
parameters :: [Parameter]
$sel:parameters:GetParametersResponse' :: GetParametersResponse -> [Parameter]
parameters} -> [Parameter]
parameters) (\s :: GetParametersResponse
s@GetParametersResponse' {} [Parameter]
a -> GetParametersResponse
s {$sel:parameters:GetParametersResponse' :: [Parameter]
parameters = [Parameter]
a} :: GetParametersResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.NFData GetParametersResponse where
  rnf :: GetParametersResponse -> ()
rnf GetParametersResponse' {Int
[Text]
[Parameter]
parameters :: [Parameter]
invalidParameters :: [Text]
httpStatus :: Int
$sel:parameters:GetParametersResponse' :: GetParametersResponse -> [Parameter]
$sel:invalidParameters:GetParametersResponse' :: GetParametersResponse -> [Text]
$sel:httpStatus:GetParametersResponse' :: GetParametersResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [Text]
invalidParameters
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [Parameter]
parameters