{-# 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.OpsWorks.DescribeStacks
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Requests a description of one or more stacks.
--
-- __Required Permissions__: To use this action, an IAM user must have a
-- Show, Deploy, or Manage permissions level for the stack, or an attached
-- policy that explicitly grants permissions. For more information about
-- user permissions, see
-- <https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html Managing User Permissions>.
module Amazonka.OpsWorks.DescribeStacks
  ( -- * Creating a Request
    DescribeStacks (..),
    newDescribeStacks,

    -- * Request Lenses
    describeStacks_stackIds,

    -- * Destructuring the Response
    DescribeStacksResponse (..),
    newDescribeStacksResponse,

    -- * Response Lenses
    describeStacksResponse_stacks,
    describeStacksResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeStacks' smart constructor.
data DescribeStacks = DescribeStacks'
  { -- | An array of stack IDs that specify the stacks to be described. If you
    -- omit this parameter, @DescribeStacks@ returns a description of every
    -- stack.
    DescribeStacks -> Maybe [Text]
stackIds :: Prelude.Maybe [Prelude.Text]
  }
  deriving (DescribeStacks -> DescribeStacks -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeStacks -> DescribeStacks -> Bool
$c/= :: DescribeStacks -> DescribeStacks -> Bool
== :: DescribeStacks -> DescribeStacks -> Bool
$c== :: DescribeStacks -> DescribeStacks -> Bool
Prelude.Eq, ReadPrec [DescribeStacks]
ReadPrec DescribeStacks
Int -> ReadS DescribeStacks
ReadS [DescribeStacks]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeStacks]
$creadListPrec :: ReadPrec [DescribeStacks]
readPrec :: ReadPrec DescribeStacks
$creadPrec :: ReadPrec DescribeStacks
readList :: ReadS [DescribeStacks]
$creadList :: ReadS [DescribeStacks]
readsPrec :: Int -> ReadS DescribeStacks
$creadsPrec :: Int -> ReadS DescribeStacks
Prelude.Read, Int -> DescribeStacks -> ShowS
[DescribeStacks] -> ShowS
DescribeStacks -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeStacks] -> ShowS
$cshowList :: [DescribeStacks] -> ShowS
show :: DescribeStacks -> String
$cshow :: DescribeStacks -> String
showsPrec :: Int -> DescribeStacks -> ShowS
$cshowsPrec :: Int -> DescribeStacks -> ShowS
Prelude.Show, forall x. Rep DescribeStacks x -> DescribeStacks
forall x. DescribeStacks -> Rep DescribeStacks x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeStacks x -> DescribeStacks
$cfrom :: forall x. DescribeStacks -> Rep DescribeStacks x
Prelude.Generic)

-- |
-- Create a value of 'DescribeStacks' 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:
--
-- 'stackIds', 'describeStacks_stackIds' - An array of stack IDs that specify the stacks to be described. If you
-- omit this parameter, @DescribeStacks@ returns a description of every
-- stack.
newDescribeStacks ::
  DescribeStacks
newDescribeStacks :: DescribeStacks
newDescribeStacks =
  DescribeStacks' {$sel:stackIds:DescribeStacks' :: Maybe [Text]
stackIds = forall a. Maybe a
Prelude.Nothing}

-- | An array of stack IDs that specify the stacks to be described. If you
-- omit this parameter, @DescribeStacks@ returns a description of every
-- stack.
describeStacks_stackIds :: Lens.Lens' DescribeStacks (Prelude.Maybe [Prelude.Text])
describeStacks_stackIds :: Lens' DescribeStacks (Maybe [Text])
describeStacks_stackIds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeStacks' {Maybe [Text]
stackIds :: Maybe [Text]
$sel:stackIds:DescribeStacks' :: DescribeStacks -> Maybe [Text]
stackIds} -> Maybe [Text]
stackIds) (\s :: DescribeStacks
s@DescribeStacks' {} Maybe [Text]
a -> DescribeStacks
s {$sel:stackIds:DescribeStacks' :: Maybe [Text]
stackIds = Maybe [Text]
a} :: DescribeStacks) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.AWSRequest DescribeStacks where
  type
    AWSResponse DescribeStacks =
      DescribeStacksResponse
  request :: (Service -> Service) -> DescribeStacks -> Request DescribeStacks
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 DescribeStacks
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeStacks)))
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 [Stack] -> Int -> DescribeStacksResponse
DescribeStacksResponse'
            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
"Stacks" 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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DescribeStacks where
  hashWithSalt :: Int -> DescribeStacks -> Int
hashWithSalt Int
_salt DescribeStacks' {Maybe [Text]
stackIds :: Maybe [Text]
$sel:stackIds:DescribeStacks' :: DescribeStacks -> Maybe [Text]
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
stackIds

instance Prelude.NFData DescribeStacks where
  rnf :: DescribeStacks -> ()
rnf DescribeStacks' {Maybe [Text]
stackIds :: Maybe [Text]
$sel:stackIds:DescribeStacks' :: DescribeStacks -> Maybe [Text]
..} = forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
stackIds

instance Data.ToHeaders DescribeStacks where
  toHeaders :: DescribeStacks -> 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
"OpsWorks_20130218.DescribeStacks" ::
                          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 DescribeStacks where
  toJSON :: DescribeStacks -> Value
toJSON DescribeStacks' {Maybe [Text]
stackIds :: Maybe [Text]
$sel:stackIds:DescribeStacks' :: DescribeStacks -> Maybe [Text]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [(Key
"StackIds" 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 [Text]
stackIds]
      )

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

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

-- | Contains the response to a @DescribeStacks@ request.
--
-- /See:/ 'newDescribeStacksResponse' smart constructor.
data DescribeStacksResponse = DescribeStacksResponse'
  { -- | An array of @Stack@ objects that describe the stacks.
    DescribeStacksResponse -> Maybe [Stack]
stacks :: Prelude.Maybe [Stack],
    -- | The response's http status code.
    DescribeStacksResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeStacksResponse -> DescribeStacksResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeStacksResponse -> DescribeStacksResponse -> Bool
$c/= :: DescribeStacksResponse -> DescribeStacksResponse -> Bool
== :: DescribeStacksResponse -> DescribeStacksResponse -> Bool
$c== :: DescribeStacksResponse -> DescribeStacksResponse -> Bool
Prelude.Eq, ReadPrec [DescribeStacksResponse]
ReadPrec DescribeStacksResponse
Int -> ReadS DescribeStacksResponse
ReadS [DescribeStacksResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeStacksResponse]
$creadListPrec :: ReadPrec [DescribeStacksResponse]
readPrec :: ReadPrec DescribeStacksResponse
$creadPrec :: ReadPrec DescribeStacksResponse
readList :: ReadS [DescribeStacksResponse]
$creadList :: ReadS [DescribeStacksResponse]
readsPrec :: Int -> ReadS DescribeStacksResponse
$creadsPrec :: Int -> ReadS DescribeStacksResponse
Prelude.Read, Int -> DescribeStacksResponse -> ShowS
[DescribeStacksResponse] -> ShowS
DescribeStacksResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeStacksResponse] -> ShowS
$cshowList :: [DescribeStacksResponse] -> ShowS
show :: DescribeStacksResponse -> String
$cshow :: DescribeStacksResponse -> String
showsPrec :: Int -> DescribeStacksResponse -> ShowS
$cshowsPrec :: Int -> DescribeStacksResponse -> ShowS
Prelude.Show, forall x. Rep DescribeStacksResponse x -> DescribeStacksResponse
forall x. DescribeStacksResponse -> Rep DescribeStacksResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeStacksResponse x -> DescribeStacksResponse
$cfrom :: forall x. DescribeStacksResponse -> Rep DescribeStacksResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeStacksResponse' 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:
--
-- 'stacks', 'describeStacksResponse_stacks' - An array of @Stack@ objects that describe the stacks.
--
-- 'httpStatus', 'describeStacksResponse_httpStatus' - The response's http status code.
newDescribeStacksResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeStacksResponse
newDescribeStacksResponse :: Int -> DescribeStacksResponse
newDescribeStacksResponse Int
pHttpStatus_ =
  DescribeStacksResponse'
    { $sel:stacks:DescribeStacksResponse' :: Maybe [Stack]
stacks = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeStacksResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | An array of @Stack@ objects that describe the stacks.
describeStacksResponse_stacks :: Lens.Lens' DescribeStacksResponse (Prelude.Maybe [Stack])
describeStacksResponse_stacks :: Lens' DescribeStacksResponse (Maybe [Stack])
describeStacksResponse_stacks = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeStacksResponse' {Maybe [Stack]
stacks :: Maybe [Stack]
$sel:stacks:DescribeStacksResponse' :: DescribeStacksResponse -> Maybe [Stack]
stacks} -> Maybe [Stack]
stacks) (\s :: DescribeStacksResponse
s@DescribeStacksResponse' {} Maybe [Stack]
a -> DescribeStacksResponse
s {$sel:stacks:DescribeStacksResponse' :: Maybe [Stack]
stacks = Maybe [Stack]
a} :: DescribeStacksResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

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

instance Prelude.NFData DescribeStacksResponse where
  rnf :: DescribeStacksResponse -> ()
rnf DescribeStacksResponse' {Int
Maybe [Stack]
httpStatus :: Int
stacks :: Maybe [Stack]
$sel:httpStatus:DescribeStacksResponse' :: DescribeStacksResponse -> Int
$sel:stacks:DescribeStacksResponse' :: DescribeStacksResponse -> Maybe [Stack]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Stack]
stacks
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus