{-# 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.DescribeDeployments
-- 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 a specified set of deployments.
--
-- This call accepts only one resource-identifying parameter.
--
-- __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.DescribeDeployments
  ( -- * Creating a Request
    DescribeDeployments (..),
    newDescribeDeployments,

    -- * Request Lenses
    describeDeployments_appId,
    describeDeployments_deploymentIds,
    describeDeployments_stackId,

    -- * Destructuring the Response
    DescribeDeploymentsResponse (..),
    newDescribeDeploymentsResponse,

    -- * Response Lenses
    describeDeploymentsResponse_deployments,
    describeDeploymentsResponse_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:/ 'newDescribeDeployments' smart constructor.
data DescribeDeployments = DescribeDeployments'
  { -- | The app ID. If you include this parameter, the command returns a
    -- description of the commands associated with the specified app.
    DescribeDeployments -> Maybe Text
appId :: Prelude.Maybe Prelude.Text,
    -- | An array of deployment IDs to be described. If you include this
    -- parameter, the command returns a description of the specified
    -- deployments. Otherwise, it returns a description of every deployment.
    DescribeDeployments -> Maybe [Text]
deploymentIds :: Prelude.Maybe [Prelude.Text],
    -- | The stack ID. If you include this parameter, the command returns a
    -- description of the commands associated with the specified stack.
    DescribeDeployments -> Maybe Text
stackId :: Prelude.Maybe Prelude.Text
  }
  deriving (DescribeDeployments -> DescribeDeployments -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeDeployments -> DescribeDeployments -> Bool
$c/= :: DescribeDeployments -> DescribeDeployments -> Bool
== :: DescribeDeployments -> DescribeDeployments -> Bool
$c== :: DescribeDeployments -> DescribeDeployments -> Bool
Prelude.Eq, ReadPrec [DescribeDeployments]
ReadPrec DescribeDeployments
Int -> ReadS DescribeDeployments
ReadS [DescribeDeployments]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeDeployments]
$creadListPrec :: ReadPrec [DescribeDeployments]
readPrec :: ReadPrec DescribeDeployments
$creadPrec :: ReadPrec DescribeDeployments
readList :: ReadS [DescribeDeployments]
$creadList :: ReadS [DescribeDeployments]
readsPrec :: Int -> ReadS DescribeDeployments
$creadsPrec :: Int -> ReadS DescribeDeployments
Prelude.Read, Int -> DescribeDeployments -> ShowS
[DescribeDeployments] -> ShowS
DescribeDeployments -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeDeployments] -> ShowS
$cshowList :: [DescribeDeployments] -> ShowS
show :: DescribeDeployments -> String
$cshow :: DescribeDeployments -> String
showsPrec :: Int -> DescribeDeployments -> ShowS
$cshowsPrec :: Int -> DescribeDeployments -> ShowS
Prelude.Show, forall x. Rep DescribeDeployments x -> DescribeDeployments
forall x. DescribeDeployments -> Rep DescribeDeployments x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeDeployments x -> DescribeDeployments
$cfrom :: forall x. DescribeDeployments -> Rep DescribeDeployments x
Prelude.Generic)

-- |
-- Create a value of 'DescribeDeployments' 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:
--
-- 'appId', 'describeDeployments_appId' - The app ID. If you include this parameter, the command returns a
-- description of the commands associated with the specified app.
--
-- 'deploymentIds', 'describeDeployments_deploymentIds' - An array of deployment IDs to be described. If you include this
-- parameter, the command returns a description of the specified
-- deployments. Otherwise, it returns a description of every deployment.
--
-- 'stackId', 'describeDeployments_stackId' - The stack ID. If you include this parameter, the command returns a
-- description of the commands associated with the specified stack.
newDescribeDeployments ::
  DescribeDeployments
newDescribeDeployments :: DescribeDeployments
newDescribeDeployments =
  DescribeDeployments'
    { $sel:appId:DescribeDeployments' :: Maybe Text
appId = forall a. Maybe a
Prelude.Nothing,
      $sel:deploymentIds:DescribeDeployments' :: Maybe [Text]
deploymentIds = forall a. Maybe a
Prelude.Nothing,
      $sel:stackId:DescribeDeployments' :: Maybe Text
stackId = forall a. Maybe a
Prelude.Nothing
    }

-- | The app ID. If you include this parameter, the command returns a
-- description of the commands associated with the specified app.
describeDeployments_appId :: Lens.Lens' DescribeDeployments (Prelude.Maybe Prelude.Text)
describeDeployments_appId :: Lens' DescribeDeployments (Maybe Text)
describeDeployments_appId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDeployments' {Maybe Text
appId :: Maybe Text
$sel:appId:DescribeDeployments' :: DescribeDeployments -> Maybe Text
appId} -> Maybe Text
appId) (\s :: DescribeDeployments
s@DescribeDeployments' {} Maybe Text
a -> DescribeDeployments
s {$sel:appId:DescribeDeployments' :: Maybe Text
appId = Maybe Text
a} :: DescribeDeployments)

-- | An array of deployment IDs to be described. If you include this
-- parameter, the command returns a description of the specified
-- deployments. Otherwise, it returns a description of every deployment.
describeDeployments_deploymentIds :: Lens.Lens' DescribeDeployments (Prelude.Maybe [Prelude.Text])
describeDeployments_deploymentIds :: Lens' DescribeDeployments (Maybe [Text])
describeDeployments_deploymentIds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDeployments' {Maybe [Text]
deploymentIds :: Maybe [Text]
$sel:deploymentIds:DescribeDeployments' :: DescribeDeployments -> Maybe [Text]
deploymentIds} -> Maybe [Text]
deploymentIds) (\s :: DescribeDeployments
s@DescribeDeployments' {} Maybe [Text]
a -> DescribeDeployments
s {$sel:deploymentIds:DescribeDeployments' :: Maybe [Text]
deploymentIds = Maybe [Text]
a} :: DescribeDeployments) 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 stack ID. If you include this parameter, the command returns a
-- description of the commands associated with the specified stack.
describeDeployments_stackId :: Lens.Lens' DescribeDeployments (Prelude.Maybe Prelude.Text)
describeDeployments_stackId :: Lens' DescribeDeployments (Maybe Text)
describeDeployments_stackId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDeployments' {Maybe Text
stackId :: Maybe Text
$sel:stackId:DescribeDeployments' :: DescribeDeployments -> Maybe Text
stackId} -> Maybe Text
stackId) (\s :: DescribeDeployments
s@DescribeDeployments' {} Maybe Text
a -> DescribeDeployments
s {$sel:stackId:DescribeDeployments' :: Maybe Text
stackId = Maybe Text
a} :: DescribeDeployments)

instance Core.AWSRequest DescribeDeployments where
  type
    AWSResponse DescribeDeployments =
      DescribeDeploymentsResponse
  request :: (Service -> Service)
-> DescribeDeployments -> Request DescribeDeployments
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 DescribeDeployments
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeDeployments)))
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 [Deployment] -> Int -> DescribeDeploymentsResponse
DescribeDeploymentsResponse'
            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
"Deployments" 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 DescribeDeployments where
  hashWithSalt :: Int -> DescribeDeployments -> Int
hashWithSalt Int
_salt DescribeDeployments' {Maybe [Text]
Maybe Text
stackId :: Maybe Text
deploymentIds :: Maybe [Text]
appId :: Maybe Text
$sel:stackId:DescribeDeployments' :: DescribeDeployments -> Maybe Text
$sel:deploymentIds:DescribeDeployments' :: DescribeDeployments -> Maybe [Text]
$sel:appId:DescribeDeployments' :: DescribeDeployments -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
appId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
deploymentIds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
stackId

instance Prelude.NFData DescribeDeployments where
  rnf :: DescribeDeployments -> ()
rnf DescribeDeployments' {Maybe [Text]
Maybe Text
stackId :: Maybe Text
deploymentIds :: Maybe [Text]
appId :: Maybe Text
$sel:stackId:DescribeDeployments' :: DescribeDeployments -> Maybe Text
$sel:deploymentIds:DescribeDeployments' :: DescribeDeployments -> Maybe [Text]
$sel:appId:DescribeDeployments' :: DescribeDeployments -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
appId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
deploymentIds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
stackId

instance Data.ToHeaders DescribeDeployments where
  toHeaders :: DescribeDeployments -> 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.DescribeDeployments" ::
                          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 DescribeDeployments where
  toJSON :: DescribeDeployments -> Value
toJSON DescribeDeployments' {Maybe [Text]
Maybe Text
stackId :: Maybe Text
deploymentIds :: Maybe [Text]
appId :: Maybe Text
$sel:stackId:DescribeDeployments' :: DescribeDeployments -> Maybe Text
$sel:deploymentIds:DescribeDeployments' :: DescribeDeployments -> Maybe [Text]
$sel:appId:DescribeDeployments' :: DescribeDeployments -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"AppId" 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
appId,
            (Key
"DeploymentIds" 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]
deploymentIds,
            (Key
"StackId" 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
stackId
          ]
      )

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

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

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

-- |
-- Create a value of 'DescribeDeploymentsResponse' 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:
--
-- 'deployments', 'describeDeploymentsResponse_deployments' - An array of @Deployment@ objects that describe the deployments.
--
-- 'httpStatus', 'describeDeploymentsResponse_httpStatus' - The response's http status code.
newDescribeDeploymentsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeDeploymentsResponse
newDescribeDeploymentsResponse :: Int -> DescribeDeploymentsResponse
newDescribeDeploymentsResponse Int
pHttpStatus_ =
  DescribeDeploymentsResponse'
    { $sel:deployments:DescribeDeploymentsResponse' :: Maybe [Deployment]
deployments =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeDeploymentsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | An array of @Deployment@ objects that describe the deployments.
describeDeploymentsResponse_deployments :: Lens.Lens' DescribeDeploymentsResponse (Prelude.Maybe [Deployment])
describeDeploymentsResponse_deployments :: Lens' DescribeDeploymentsResponse (Maybe [Deployment])
describeDeploymentsResponse_deployments = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDeploymentsResponse' {Maybe [Deployment]
deployments :: Maybe [Deployment]
$sel:deployments:DescribeDeploymentsResponse' :: DescribeDeploymentsResponse -> Maybe [Deployment]
deployments} -> Maybe [Deployment]
deployments) (\s :: DescribeDeploymentsResponse
s@DescribeDeploymentsResponse' {} Maybe [Deployment]
a -> DescribeDeploymentsResponse
s {$sel:deployments:DescribeDeploymentsResponse' :: Maybe [Deployment]
deployments = Maybe [Deployment]
a} :: DescribeDeploymentsResponse) 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.
describeDeploymentsResponse_httpStatus :: Lens.Lens' DescribeDeploymentsResponse Prelude.Int
describeDeploymentsResponse_httpStatus :: Lens' DescribeDeploymentsResponse Int
describeDeploymentsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDeploymentsResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeDeploymentsResponse' :: DescribeDeploymentsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeDeploymentsResponse
s@DescribeDeploymentsResponse' {} Int
a -> DescribeDeploymentsResponse
s {$sel:httpStatus:DescribeDeploymentsResponse' :: Int
httpStatus = Int
a} :: DescribeDeploymentsResponse)

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