{-# 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.ApiGatewayV2.GetStages
-- 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 the Stages for an API.
--
-- This operation returns paginated results.
module Amazonka.ApiGatewayV2.GetStages
  ( -- * Creating a Request
    GetStages (..),
    newGetStages,

    -- * Request Lenses
    getStages_maxResults,
    getStages_nextToken,
    getStages_apiId,

    -- * Destructuring the Response
    GetStagesResponse (..),
    newGetStagesResponse,

    -- * Response Lenses
    getStagesResponse_items,
    getStagesResponse_nextToken,
    getStagesResponse_httpStatus,
  )
where

import Amazonka.ApiGatewayV2.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

-- | /See:/ 'newGetStages' smart constructor.
data GetStages = GetStages'
  { -- | The maximum number of elements to be returned for this resource.
    GetStages -> Maybe Text
maxResults :: Prelude.Maybe Prelude.Text,
    -- | The next page of elements from this collection. Not valid for the last
    -- element of the collection.
    GetStages -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The API identifier.
    GetStages -> Text
apiId :: Prelude.Text
  }
  deriving (GetStages -> GetStages -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetStages -> GetStages -> Bool
$c/= :: GetStages -> GetStages -> Bool
== :: GetStages -> GetStages -> Bool
$c== :: GetStages -> GetStages -> Bool
Prelude.Eq, ReadPrec [GetStages]
ReadPrec GetStages
Int -> ReadS GetStages
ReadS [GetStages]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetStages]
$creadListPrec :: ReadPrec [GetStages]
readPrec :: ReadPrec GetStages
$creadPrec :: ReadPrec GetStages
readList :: ReadS [GetStages]
$creadList :: ReadS [GetStages]
readsPrec :: Int -> ReadS GetStages
$creadsPrec :: Int -> ReadS GetStages
Prelude.Read, Int -> GetStages -> ShowS
[GetStages] -> ShowS
GetStages -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetStages] -> ShowS
$cshowList :: [GetStages] -> ShowS
show :: GetStages -> String
$cshow :: GetStages -> String
showsPrec :: Int -> GetStages -> ShowS
$cshowsPrec :: Int -> GetStages -> ShowS
Prelude.Show, forall x. Rep GetStages x -> GetStages
forall x. GetStages -> Rep GetStages x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetStages x -> GetStages
$cfrom :: forall x. GetStages -> Rep GetStages x
Prelude.Generic)

-- |
-- Create a value of 'GetStages' 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:
--
-- 'maxResults', 'getStages_maxResults' - The maximum number of elements to be returned for this resource.
--
-- 'nextToken', 'getStages_nextToken' - The next page of elements from this collection. Not valid for the last
-- element of the collection.
--
-- 'apiId', 'getStages_apiId' - The API identifier.
newGetStages ::
  -- | 'apiId'
  Prelude.Text ->
  GetStages
newGetStages :: Text -> GetStages
newGetStages Text
pApiId_ =
  GetStages'
    { $sel:maxResults:GetStages' :: Maybe Text
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:GetStages' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:apiId:GetStages' :: Text
apiId = Text
pApiId_
    }

-- | The maximum number of elements to be returned for this resource.
getStages_maxResults :: Lens.Lens' GetStages (Prelude.Maybe Prelude.Text)
getStages_maxResults :: Lens' GetStages (Maybe Text)
getStages_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetStages' {Maybe Text
maxResults :: Maybe Text
$sel:maxResults:GetStages' :: GetStages -> Maybe Text
maxResults} -> Maybe Text
maxResults) (\s :: GetStages
s@GetStages' {} Maybe Text
a -> GetStages
s {$sel:maxResults:GetStages' :: Maybe Text
maxResults = Maybe Text
a} :: GetStages)

-- | The next page of elements from this collection. Not valid for the last
-- element of the collection.
getStages_nextToken :: Lens.Lens' GetStages (Prelude.Maybe Prelude.Text)
getStages_nextToken :: Lens' GetStages (Maybe Text)
getStages_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetStages' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:GetStages' :: GetStages -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: GetStages
s@GetStages' {} Maybe Text
a -> GetStages
s {$sel:nextToken:GetStages' :: Maybe Text
nextToken = Maybe Text
a} :: GetStages)

-- | The API identifier.
getStages_apiId :: Lens.Lens' GetStages Prelude.Text
getStages_apiId :: Lens' GetStages Text
getStages_apiId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetStages' {Text
apiId :: Text
$sel:apiId:GetStages' :: GetStages -> Text
apiId} -> Text
apiId) (\s :: GetStages
s@GetStages' {} Text
a -> GetStages
s {$sel:apiId:GetStages' :: Text
apiId = Text
a} :: GetStages)

instance Core.AWSPager GetStages where
  page :: GetStages -> AWSResponse GetStages -> Maybe GetStages
page GetStages
rq AWSResponse GetStages
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse GetStages
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetStagesResponse (Maybe Text)
getStagesResponse_nextToken
            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 GetStages
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetStagesResponse (Maybe [Stage])
getStagesResponse_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.$ GetStages
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' GetStages (Maybe Text)
getStages_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse GetStages
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetStagesResponse (Maybe Text)
getStagesResponse_nextToken
          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 GetStages where
  type AWSResponse GetStages = GetStagesResponse
  request :: (Service -> Service) -> GetStages -> Request GetStages
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 GetStages
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetStages)))
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 [Stage] -> Maybe Text -> Int -> GetStagesResponse
GetStagesResponse'
            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
"items" 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
"nextToken")
            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 GetStages where
  hashWithSalt :: Int -> GetStages -> Int
hashWithSalt Int
_salt GetStages' {Maybe Text
Text
apiId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Text
$sel:apiId:GetStages' :: GetStages -> Text
$sel:nextToken:GetStages' :: GetStages -> Maybe Text
$sel:maxResults:GetStages' :: GetStages -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
apiId

instance Prelude.NFData GetStages where
  rnf :: GetStages -> ()
rnf GetStages' {Maybe Text
Text
apiId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Text
$sel:apiId:GetStages' :: GetStages -> Text
$sel:nextToken:GetStages' :: GetStages -> Maybe Text
$sel:maxResults:GetStages' :: GetStages -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
apiId

instance Data.ToHeaders GetStages where
  toHeaders :: GetStages -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToPath GetStages where
  toPath :: GetStages -> ByteString
toPath GetStages' {Maybe Text
Text
apiId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Text
$sel:apiId:GetStages' :: GetStages -> Text
$sel:nextToken:GetStages' :: GetStages -> Maybe Text
$sel:maxResults:GetStages' :: GetStages -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"/v2/apis/", forall a. ToByteString a => a -> ByteString
Data.toBS Text
apiId, ByteString
"/stages"]

instance Data.ToQuery GetStages where
  toQuery :: GetStages -> QueryString
toQuery GetStages' {Maybe Text
Text
apiId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Text
$sel:apiId:GetStages' :: GetStages -> Text
$sel:nextToken:GetStages' :: GetStages -> Maybe Text
$sel:maxResults:GetStages' :: GetStages -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"maxResults" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
maxResults,
        ByteString
"nextToken" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nextToken
      ]

-- | /See:/ 'newGetStagesResponse' smart constructor.
data GetStagesResponse = GetStagesResponse'
  { -- | The elements from this collection.
    GetStagesResponse -> Maybe [Stage]
items :: Prelude.Maybe [Stage],
    -- | The next page of elements from this collection. Not valid for the last
    -- element of the collection.
    GetStagesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    GetStagesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetStagesResponse -> GetStagesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetStagesResponse -> GetStagesResponse -> Bool
$c/= :: GetStagesResponse -> GetStagesResponse -> Bool
== :: GetStagesResponse -> GetStagesResponse -> Bool
$c== :: GetStagesResponse -> GetStagesResponse -> Bool
Prelude.Eq, ReadPrec [GetStagesResponse]
ReadPrec GetStagesResponse
Int -> ReadS GetStagesResponse
ReadS [GetStagesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetStagesResponse]
$creadListPrec :: ReadPrec [GetStagesResponse]
readPrec :: ReadPrec GetStagesResponse
$creadPrec :: ReadPrec GetStagesResponse
readList :: ReadS [GetStagesResponse]
$creadList :: ReadS [GetStagesResponse]
readsPrec :: Int -> ReadS GetStagesResponse
$creadsPrec :: Int -> ReadS GetStagesResponse
Prelude.Read, Int -> GetStagesResponse -> ShowS
[GetStagesResponse] -> ShowS
GetStagesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetStagesResponse] -> ShowS
$cshowList :: [GetStagesResponse] -> ShowS
show :: GetStagesResponse -> String
$cshow :: GetStagesResponse -> String
showsPrec :: Int -> GetStagesResponse -> ShowS
$cshowsPrec :: Int -> GetStagesResponse -> ShowS
Prelude.Show, forall x. Rep GetStagesResponse x -> GetStagesResponse
forall x. GetStagesResponse -> Rep GetStagesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetStagesResponse x -> GetStagesResponse
$cfrom :: forall x. GetStagesResponse -> Rep GetStagesResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetStagesResponse' 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', 'getStagesResponse_items' - The elements from this collection.
--
-- 'nextToken', 'getStagesResponse_nextToken' - The next page of elements from this collection. Not valid for the last
-- element of the collection.
--
-- 'httpStatus', 'getStagesResponse_httpStatus' - The response's http status code.
newGetStagesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetStagesResponse
newGetStagesResponse :: Int -> GetStagesResponse
newGetStagesResponse Int
pHttpStatus_ =
  GetStagesResponse'
    { $sel:items:GetStagesResponse' :: Maybe [Stage]
items = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:GetStagesResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetStagesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The elements from this collection.
getStagesResponse_items :: Lens.Lens' GetStagesResponse (Prelude.Maybe [Stage])
getStagesResponse_items :: Lens' GetStagesResponse (Maybe [Stage])
getStagesResponse_items = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetStagesResponse' {Maybe [Stage]
items :: Maybe [Stage]
$sel:items:GetStagesResponse' :: GetStagesResponse -> Maybe [Stage]
items} -> Maybe [Stage]
items) (\s :: GetStagesResponse
s@GetStagesResponse' {} Maybe [Stage]
a -> GetStagesResponse
s {$sel:items:GetStagesResponse' :: Maybe [Stage]
items = Maybe [Stage]
a} :: GetStagesResponse) 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 next page of elements from this collection. Not valid for the last
-- element of the collection.
getStagesResponse_nextToken :: Lens.Lens' GetStagesResponse (Prelude.Maybe Prelude.Text)
getStagesResponse_nextToken :: Lens' GetStagesResponse (Maybe Text)
getStagesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetStagesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:GetStagesResponse' :: GetStagesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: GetStagesResponse
s@GetStagesResponse' {} Maybe Text
a -> GetStagesResponse
s {$sel:nextToken:GetStagesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: GetStagesResponse)

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

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