{-# 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.BackupGateway.ListGateways
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Lists backup gateways owned by an Amazon Web Services account in an
-- Amazon Web Services Region. The returned list is ordered by gateway
-- Amazon Resource Name (ARN).
--
-- This operation returns paginated results.
module Amazonka.BackupGateway.ListGateways
  ( -- * Creating a Request
    ListGateways (..),
    newListGateways,

    -- * Request Lenses
    listGateways_maxResults,
    listGateways_nextToken,

    -- * Destructuring the Response
    ListGatewaysResponse (..),
    newListGatewaysResponse,

    -- * Response Lenses
    listGatewaysResponse_gateways,
    listGatewaysResponse_nextToken,
    listGatewaysResponse_httpStatus,
  )
where

import Amazonka.BackupGateway.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:/ 'newListGateways' smart constructor.
data ListGateways = ListGateways'
  { -- | The maximum number of gateways to list.
    ListGateways -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The next item following a partial list of returned resources. For
    -- example, if a request is made to return @MaxResults@ number of
    -- resources, @NextToken@ allows you to return more items in your list
    -- starting at the location pointed to by the next token.
    ListGateways -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListGateways -> ListGateways -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListGateways -> ListGateways -> Bool
$c/= :: ListGateways -> ListGateways -> Bool
== :: ListGateways -> ListGateways -> Bool
$c== :: ListGateways -> ListGateways -> Bool
Prelude.Eq, ReadPrec [ListGateways]
ReadPrec ListGateways
Int -> ReadS ListGateways
ReadS [ListGateways]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListGateways]
$creadListPrec :: ReadPrec [ListGateways]
readPrec :: ReadPrec ListGateways
$creadPrec :: ReadPrec ListGateways
readList :: ReadS [ListGateways]
$creadList :: ReadS [ListGateways]
readsPrec :: Int -> ReadS ListGateways
$creadsPrec :: Int -> ReadS ListGateways
Prelude.Read, Int -> ListGateways -> ShowS
[ListGateways] -> ShowS
ListGateways -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListGateways] -> ShowS
$cshowList :: [ListGateways] -> ShowS
show :: ListGateways -> String
$cshow :: ListGateways -> String
showsPrec :: Int -> ListGateways -> ShowS
$cshowsPrec :: Int -> ListGateways -> ShowS
Prelude.Show, forall x. Rep ListGateways x -> ListGateways
forall x. ListGateways -> Rep ListGateways x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListGateways x -> ListGateways
$cfrom :: forall x. ListGateways -> Rep ListGateways x
Prelude.Generic)

-- |
-- Create a value of 'ListGateways' 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', 'listGateways_maxResults' - The maximum number of gateways to list.
--
-- 'nextToken', 'listGateways_nextToken' - The next item following a partial list of returned resources. For
-- example, if a request is made to return @MaxResults@ number of
-- resources, @NextToken@ allows you to return more items in your list
-- starting at the location pointed to by the next token.
newListGateways ::
  ListGateways
newListGateways :: ListGateways
newListGateways =
  ListGateways'
    { $sel:maxResults:ListGateways' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListGateways' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of gateways to list.
listGateways_maxResults :: Lens.Lens' ListGateways (Prelude.Maybe Prelude.Natural)
listGateways_maxResults :: Lens' ListGateways (Maybe Natural)
listGateways_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListGateways' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListGateways' :: ListGateways -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListGateways
s@ListGateways' {} Maybe Natural
a -> ListGateways
s {$sel:maxResults:ListGateways' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListGateways)

-- | The next item following a partial list of returned resources. For
-- example, if a request is made to return @MaxResults@ number of
-- resources, @NextToken@ allows you to return more items in your list
-- starting at the location pointed to by the next token.
listGateways_nextToken :: Lens.Lens' ListGateways (Prelude.Maybe Prelude.Text)
listGateways_nextToken :: Lens' ListGateways (Maybe Text)
listGateways_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListGateways' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListGateways' :: ListGateways -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListGateways
s@ListGateways' {} Maybe Text
a -> ListGateways
s {$sel:nextToken:ListGateways' :: Maybe Text
nextToken = Maybe Text
a} :: ListGateways)

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

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

instance Data.ToHeaders ListGateways where
  toHeaders :: ListGateways -> 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
"BackupOnPremises_v20210101.ListGateways" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.0" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON ListGateways where
  toJSON :: ListGateways -> Value
toJSON ListGateways' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListGateways' :: ListGateways -> Maybe Text
$sel:maxResults:ListGateways' :: ListGateways -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"MaxResults" 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 Natural
maxResults,
            (Key
"NextToken" 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
nextToken
          ]
      )

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

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

-- | /See:/ 'newListGatewaysResponse' smart constructor.
data ListGatewaysResponse = ListGatewaysResponse'
  { -- | A list of your gateways.
    ListGatewaysResponse -> Maybe [Gateway]
gateways :: Prelude.Maybe [Gateway],
    -- | The next item following a partial list of returned resources. For
    -- example, if a request is made to return @maxResults@ number of
    -- resources, @NextToken@ allows you to return more items in your list
    -- starting at the location pointed to by the next token.
    ListGatewaysResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListGatewaysResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListGatewaysResponse -> ListGatewaysResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListGatewaysResponse -> ListGatewaysResponse -> Bool
$c/= :: ListGatewaysResponse -> ListGatewaysResponse -> Bool
== :: ListGatewaysResponse -> ListGatewaysResponse -> Bool
$c== :: ListGatewaysResponse -> ListGatewaysResponse -> Bool
Prelude.Eq, ReadPrec [ListGatewaysResponse]
ReadPrec ListGatewaysResponse
Int -> ReadS ListGatewaysResponse
ReadS [ListGatewaysResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListGatewaysResponse]
$creadListPrec :: ReadPrec [ListGatewaysResponse]
readPrec :: ReadPrec ListGatewaysResponse
$creadPrec :: ReadPrec ListGatewaysResponse
readList :: ReadS [ListGatewaysResponse]
$creadList :: ReadS [ListGatewaysResponse]
readsPrec :: Int -> ReadS ListGatewaysResponse
$creadsPrec :: Int -> ReadS ListGatewaysResponse
Prelude.Read, Int -> ListGatewaysResponse -> ShowS
[ListGatewaysResponse] -> ShowS
ListGatewaysResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListGatewaysResponse] -> ShowS
$cshowList :: [ListGatewaysResponse] -> ShowS
show :: ListGatewaysResponse -> String
$cshow :: ListGatewaysResponse -> String
showsPrec :: Int -> ListGatewaysResponse -> ShowS
$cshowsPrec :: Int -> ListGatewaysResponse -> ShowS
Prelude.Show, forall x. Rep ListGatewaysResponse x -> ListGatewaysResponse
forall x. ListGatewaysResponse -> Rep ListGatewaysResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListGatewaysResponse x -> ListGatewaysResponse
$cfrom :: forall x. ListGatewaysResponse -> Rep ListGatewaysResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListGatewaysResponse' 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:
--
-- 'gateways', 'listGatewaysResponse_gateways' - A list of your gateways.
--
-- 'nextToken', 'listGatewaysResponse_nextToken' - The next item following a partial list of returned resources. For
-- example, if a request is made to return @maxResults@ number of
-- resources, @NextToken@ allows you to return more items in your list
-- starting at the location pointed to by the next token.
--
-- 'httpStatus', 'listGatewaysResponse_httpStatus' - The response's http status code.
newListGatewaysResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListGatewaysResponse
newListGatewaysResponse :: Int -> ListGatewaysResponse
newListGatewaysResponse Int
pHttpStatus_ =
  ListGatewaysResponse'
    { $sel:gateways:ListGatewaysResponse' :: Maybe [Gateway]
gateways = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListGatewaysResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListGatewaysResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A list of your gateways.
listGatewaysResponse_gateways :: Lens.Lens' ListGatewaysResponse (Prelude.Maybe [Gateway])
listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [Gateway])
listGatewaysResponse_gateways = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListGatewaysResponse' {Maybe [Gateway]
gateways :: Maybe [Gateway]
$sel:gateways:ListGatewaysResponse' :: ListGatewaysResponse -> Maybe [Gateway]
gateways} -> Maybe [Gateway]
gateways) (\s :: ListGatewaysResponse
s@ListGatewaysResponse' {} Maybe [Gateway]
a -> ListGatewaysResponse
s {$sel:gateways:ListGatewaysResponse' :: Maybe [Gateway]
gateways = Maybe [Gateway]
a} :: ListGatewaysResponse) 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 item following a partial list of returned resources. For
-- example, if a request is made to return @maxResults@ number of
-- resources, @NextToken@ allows you to return more items in your list
-- starting at the location pointed to by the next token.
listGatewaysResponse_nextToken :: Lens.Lens' ListGatewaysResponse (Prelude.Maybe Prelude.Text)
listGatewaysResponse_nextToken :: Lens' ListGatewaysResponse (Maybe Text)
listGatewaysResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListGatewaysResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListGatewaysResponse' :: ListGatewaysResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListGatewaysResponse
s@ListGatewaysResponse' {} Maybe Text
a -> ListGatewaysResponse
s {$sel:nextToken:ListGatewaysResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListGatewaysResponse)

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

instance Prelude.NFData ListGatewaysResponse where
  rnf :: ListGatewaysResponse -> ()
rnf ListGatewaysResponse' {Int
Maybe [Gateway]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
gateways :: Maybe [Gateway]
$sel:httpStatus:ListGatewaysResponse' :: ListGatewaysResponse -> Int
$sel:nextToken:ListGatewaysResponse' :: ListGatewaysResponse -> Maybe Text
$sel:gateways:ListGatewaysResponse' :: ListGatewaysResponse -> Maybe [Gateway]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Gateway]
gateways
      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