{-# 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.APIGateway.GetDeployments
-- 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 Deployments collection.
--
-- This operation returns paginated results.
module Amazonka.APIGateway.GetDeployments
  ( -- * Creating a Request
    GetDeployments (..),
    newGetDeployments,

    -- * Request Lenses
    getDeployments_limit,
    getDeployments_position,
    getDeployments_restApiId,

    -- * Destructuring the Response
    GetDeploymentsResponse (..),
    newGetDeploymentsResponse,

    -- * Response Lenses
    getDeploymentsResponse_items,
    getDeploymentsResponse_position,
    getDeploymentsResponse_httpStatus,
  )
where

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

-- | Requests API Gateway to get information about a Deployments collection.
--
-- /See:/ 'newGetDeployments' smart constructor.
data GetDeployments = GetDeployments'
  { -- | The maximum number of returned results per page. The default value is 25
    -- and the maximum value is 500.
    GetDeployments -> Maybe Int
limit :: Prelude.Maybe Prelude.Int,
    -- | The current pagination position in the paged result set.
    GetDeployments -> Maybe Text
position :: Prelude.Maybe Prelude.Text,
    -- | The string identifier of the associated RestApi.
    GetDeployments -> Text
restApiId :: Prelude.Text
  }
  deriving (GetDeployments -> GetDeployments -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetDeployments -> GetDeployments -> Bool
$c/= :: GetDeployments -> GetDeployments -> Bool
== :: GetDeployments -> GetDeployments -> Bool
$c== :: GetDeployments -> GetDeployments -> Bool
Prelude.Eq, ReadPrec [GetDeployments]
ReadPrec GetDeployments
Int -> ReadS GetDeployments
ReadS [GetDeployments]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetDeployments]
$creadListPrec :: ReadPrec [GetDeployments]
readPrec :: ReadPrec GetDeployments
$creadPrec :: ReadPrec GetDeployments
readList :: ReadS [GetDeployments]
$creadList :: ReadS [GetDeployments]
readsPrec :: Int -> ReadS GetDeployments
$creadsPrec :: Int -> ReadS GetDeployments
Prelude.Read, Int -> GetDeployments -> ShowS
[GetDeployments] -> ShowS
GetDeployments -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetDeployments] -> ShowS
$cshowList :: [GetDeployments] -> ShowS
show :: GetDeployments -> String
$cshow :: GetDeployments -> String
showsPrec :: Int -> GetDeployments -> ShowS
$cshowsPrec :: Int -> GetDeployments -> ShowS
Prelude.Show, forall x. Rep GetDeployments x -> GetDeployments
forall x. GetDeployments -> Rep GetDeployments x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetDeployments x -> GetDeployments
$cfrom :: forall x. GetDeployments -> Rep GetDeployments x
Prelude.Generic)

-- |
-- Create a value of 'GetDeployments' 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:
--
-- 'limit', 'getDeployments_limit' - The maximum number of returned results per page. The default value is 25
-- and the maximum value is 500.
--
-- 'position', 'getDeployments_position' - The current pagination position in the paged result set.
--
-- 'restApiId', 'getDeployments_restApiId' - The string identifier of the associated RestApi.
newGetDeployments ::
  -- | 'restApiId'
  Prelude.Text ->
  GetDeployments
newGetDeployments :: Text -> GetDeployments
newGetDeployments Text
pRestApiId_ =
  GetDeployments'
    { $sel:limit:GetDeployments' :: Maybe Int
limit = forall a. Maybe a
Prelude.Nothing,
      $sel:position:GetDeployments' :: Maybe Text
position = forall a. Maybe a
Prelude.Nothing,
      $sel:restApiId:GetDeployments' :: Text
restApiId = Text
pRestApiId_
    }

-- | The maximum number of returned results per page. The default value is 25
-- and the maximum value is 500.
getDeployments_limit :: Lens.Lens' GetDeployments (Prelude.Maybe Prelude.Int)
getDeployments_limit :: Lens' GetDeployments (Maybe Int)
getDeployments_limit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDeployments' {Maybe Int
limit :: Maybe Int
$sel:limit:GetDeployments' :: GetDeployments -> Maybe Int
limit} -> Maybe Int
limit) (\s :: GetDeployments
s@GetDeployments' {} Maybe Int
a -> GetDeployments
s {$sel:limit:GetDeployments' :: Maybe Int
limit = Maybe Int
a} :: GetDeployments)

-- | The current pagination position in the paged result set.
getDeployments_position :: Lens.Lens' GetDeployments (Prelude.Maybe Prelude.Text)
getDeployments_position :: Lens' GetDeployments (Maybe Text)
getDeployments_position = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDeployments' {Maybe Text
position :: Maybe Text
$sel:position:GetDeployments' :: GetDeployments -> Maybe Text
position} -> Maybe Text
position) (\s :: GetDeployments
s@GetDeployments' {} Maybe Text
a -> GetDeployments
s {$sel:position:GetDeployments' :: Maybe Text
position = Maybe Text
a} :: GetDeployments)

-- | The string identifier of the associated RestApi.
getDeployments_restApiId :: Lens.Lens' GetDeployments Prelude.Text
getDeployments_restApiId :: Lens' GetDeployments Text
getDeployments_restApiId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDeployments' {Text
restApiId :: Text
$sel:restApiId:GetDeployments' :: GetDeployments -> Text
restApiId} -> Text
restApiId) (\s :: GetDeployments
s@GetDeployments' {} Text
a -> GetDeployments
s {$sel:restApiId:GetDeployments' :: Text
restApiId = Text
a} :: GetDeployments)

instance Core.AWSPager GetDeployments where
  page :: GetDeployments
-> AWSResponse GetDeployments -> Maybe GetDeployments
page GetDeployments
rq AWSResponse GetDeployments
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse GetDeployments
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetDeploymentsResponse (Maybe Text)
getDeploymentsResponse_position
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse GetDeployments
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetDeploymentsResponse (Maybe [Deployment])
getDeploymentsResponse_items
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ GetDeployments
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' GetDeployments (Maybe Text)
getDeployments_position
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse GetDeployments
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetDeploymentsResponse (Maybe Text)
getDeploymentsResponse_position
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest GetDeployments where
  type
    AWSResponse GetDeployments =
      GetDeploymentsResponse
  request :: (Service -> Service) -> GetDeployments -> Request GetDeployments
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 GetDeployments
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetDeployments)))
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] -> Maybe Text -> Int -> GetDeploymentsResponse
GetDeploymentsResponse'
            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
"item" 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
"position")
            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 GetDeployments where
  hashWithSalt :: Int -> GetDeployments -> Int
hashWithSalt Int
_salt GetDeployments' {Maybe Int
Maybe Text
Text
restApiId :: Text
position :: Maybe Text
limit :: Maybe Int
$sel:restApiId:GetDeployments' :: GetDeployments -> Text
$sel:position:GetDeployments' :: GetDeployments -> Maybe Text
$sel:limit:GetDeployments' :: GetDeployments -> Maybe Int
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
limit
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
position
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
restApiId

instance Prelude.NFData GetDeployments where
  rnf :: GetDeployments -> ()
rnf GetDeployments' {Maybe Int
Maybe Text
Text
restApiId :: Text
position :: Maybe Text
limit :: Maybe Int
$sel:restApiId:GetDeployments' :: GetDeployments -> Text
$sel:position:GetDeployments' :: GetDeployments -> Maybe Text
$sel:limit:GetDeployments' :: GetDeployments -> Maybe Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
limit
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
position
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
restApiId

instance Data.ToHeaders GetDeployments where
  toHeaders :: GetDeployments -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Accept"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# (ByteString
"application/json" :: Prelude.ByteString)
          ]
      )

instance Data.ToPath GetDeployments where
  toPath :: GetDeployments -> ByteString
toPath GetDeployments' {Maybe Int
Maybe Text
Text
restApiId :: Text
position :: Maybe Text
limit :: Maybe Int
$sel:restApiId:GetDeployments' :: GetDeployments -> Text
$sel:position:GetDeployments' :: GetDeployments -> Maybe Text
$sel:limit:GetDeployments' :: GetDeployments -> Maybe Int
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"/restapis/", forall a. ToByteString a => a -> ByteString
Data.toBS Text
restApiId, ByteString
"/deployments"]

instance Data.ToQuery GetDeployments where
  toQuery :: GetDeployments -> QueryString
toQuery GetDeployments' {Maybe Int
Maybe Text
Text
restApiId :: Text
position :: Maybe Text
limit :: Maybe Int
$sel:restApiId:GetDeployments' :: GetDeployments -> Text
$sel:position:GetDeployments' :: GetDeployments -> Maybe Text
$sel:limit:GetDeployments' :: GetDeployments -> Maybe Int
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"limit" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Int
limit, ByteString
"position" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
position]

-- | Represents a collection resource that contains zero or more references
-- to your existing deployments, and links that guide you on how to
-- interact with your collection. The collection offers a paginated view of
-- the contained deployments.
--
-- /See:/ 'newGetDeploymentsResponse' smart constructor.
data GetDeploymentsResponse = GetDeploymentsResponse'
  { -- | The current page of elements from this collection.
    GetDeploymentsResponse -> Maybe [Deployment]
items :: Prelude.Maybe [Deployment],
    GetDeploymentsResponse -> Maybe Text
position :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    GetDeploymentsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetDeploymentsResponse -> GetDeploymentsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetDeploymentsResponse -> GetDeploymentsResponse -> Bool
$c/= :: GetDeploymentsResponse -> GetDeploymentsResponse -> Bool
== :: GetDeploymentsResponse -> GetDeploymentsResponse -> Bool
$c== :: GetDeploymentsResponse -> GetDeploymentsResponse -> Bool
Prelude.Eq, ReadPrec [GetDeploymentsResponse]
ReadPrec GetDeploymentsResponse
Int -> ReadS GetDeploymentsResponse
ReadS [GetDeploymentsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetDeploymentsResponse]
$creadListPrec :: ReadPrec [GetDeploymentsResponse]
readPrec :: ReadPrec GetDeploymentsResponse
$creadPrec :: ReadPrec GetDeploymentsResponse
readList :: ReadS [GetDeploymentsResponse]
$creadList :: ReadS [GetDeploymentsResponse]
readsPrec :: Int -> ReadS GetDeploymentsResponse
$creadsPrec :: Int -> ReadS GetDeploymentsResponse
Prelude.Read, Int -> GetDeploymentsResponse -> ShowS
[GetDeploymentsResponse] -> ShowS
GetDeploymentsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetDeploymentsResponse] -> ShowS
$cshowList :: [GetDeploymentsResponse] -> ShowS
show :: GetDeploymentsResponse -> String
$cshow :: GetDeploymentsResponse -> String
showsPrec :: Int -> GetDeploymentsResponse -> ShowS
$cshowsPrec :: Int -> GetDeploymentsResponse -> ShowS
Prelude.Show, forall x. Rep GetDeploymentsResponse x -> GetDeploymentsResponse
forall x. GetDeploymentsResponse -> Rep GetDeploymentsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetDeploymentsResponse x -> GetDeploymentsResponse
$cfrom :: forall x. GetDeploymentsResponse -> Rep GetDeploymentsResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetDeploymentsResponse' 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:
--
-- 'items', 'getDeploymentsResponse_items' - The current page of elements from this collection.
--
-- 'position', 'getDeploymentsResponse_position' - Undocumented member.
--
-- 'httpStatus', 'getDeploymentsResponse_httpStatus' - The response's http status code.
newGetDeploymentsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetDeploymentsResponse
newGetDeploymentsResponse :: Int -> GetDeploymentsResponse
newGetDeploymentsResponse Int
pHttpStatus_ =
  GetDeploymentsResponse'
    { $sel:items:GetDeploymentsResponse' :: Maybe [Deployment]
items = forall a. Maybe a
Prelude.Nothing,
      $sel:position:GetDeploymentsResponse' :: Maybe Text
position = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetDeploymentsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The current page of elements from this collection.
getDeploymentsResponse_items :: Lens.Lens' GetDeploymentsResponse (Prelude.Maybe [Deployment])
getDeploymentsResponse_items :: Lens' GetDeploymentsResponse (Maybe [Deployment])
getDeploymentsResponse_items = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDeploymentsResponse' {Maybe [Deployment]
items :: Maybe [Deployment]
$sel:items:GetDeploymentsResponse' :: GetDeploymentsResponse -> Maybe [Deployment]
items} -> Maybe [Deployment]
items) (\s :: GetDeploymentsResponse
s@GetDeploymentsResponse' {} Maybe [Deployment]
a -> GetDeploymentsResponse
s {$sel:items:GetDeploymentsResponse' :: Maybe [Deployment]
items = Maybe [Deployment]
a} :: GetDeploymentsResponse) 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

-- | Undocumented member.
getDeploymentsResponse_position :: Lens.Lens' GetDeploymentsResponse (Prelude.Maybe Prelude.Text)
getDeploymentsResponse_position :: Lens' GetDeploymentsResponse (Maybe Text)
getDeploymentsResponse_position = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDeploymentsResponse' {Maybe Text
position :: Maybe Text
$sel:position:GetDeploymentsResponse' :: GetDeploymentsResponse -> Maybe Text
position} -> Maybe Text
position) (\s :: GetDeploymentsResponse
s@GetDeploymentsResponse' {} Maybe Text
a -> GetDeploymentsResponse
s {$sel:position:GetDeploymentsResponse' :: Maybe Text
position = Maybe Text
a} :: GetDeploymentsResponse)

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

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