{-# 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.NetworkManager.GetSites
-- 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 one or more of your sites in a global network.
--
-- This operation returns paginated results.
module Amazonka.NetworkManager.GetSites
  ( -- * Creating a Request
    GetSites (..),
    newGetSites,

    -- * Request Lenses
    getSites_maxResults,
    getSites_nextToken,
    getSites_siteIds,
    getSites_globalNetworkId,

    -- * Destructuring the Response
    GetSitesResponse (..),
    newGetSitesResponse,

    -- * Response Lenses
    getSitesResponse_nextToken,
    getSitesResponse_sites,
    getSitesResponse_httpStatus,
  )
where

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

-- | /See:/ 'newGetSites' smart constructor.
data GetSites = GetSites'
  { -- | The maximum number of results to return.
    GetSites -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The token for the next page of results.
    GetSites -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | One or more site IDs. The maximum is 10.
    GetSites -> Maybe [Text]
siteIds :: Prelude.Maybe [Prelude.Text],
    -- | The ID of the global network.
    GetSites -> Text
globalNetworkId :: Prelude.Text
  }
  deriving (GetSites -> GetSites -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetSites -> GetSites -> Bool
$c/= :: GetSites -> GetSites -> Bool
== :: GetSites -> GetSites -> Bool
$c== :: GetSites -> GetSites -> Bool
Prelude.Eq, ReadPrec [GetSites]
ReadPrec GetSites
Int -> ReadS GetSites
ReadS [GetSites]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetSites]
$creadListPrec :: ReadPrec [GetSites]
readPrec :: ReadPrec GetSites
$creadPrec :: ReadPrec GetSites
readList :: ReadS [GetSites]
$creadList :: ReadS [GetSites]
readsPrec :: Int -> ReadS GetSites
$creadsPrec :: Int -> ReadS GetSites
Prelude.Read, Int -> GetSites -> ShowS
[GetSites] -> ShowS
GetSites -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetSites] -> ShowS
$cshowList :: [GetSites] -> ShowS
show :: GetSites -> String
$cshow :: GetSites -> String
showsPrec :: Int -> GetSites -> ShowS
$cshowsPrec :: Int -> GetSites -> ShowS
Prelude.Show, forall x. Rep GetSites x -> GetSites
forall x. GetSites -> Rep GetSites x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetSites x -> GetSites
$cfrom :: forall x. GetSites -> Rep GetSites x
Prelude.Generic)

-- |
-- Create a value of 'GetSites' 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', 'getSites_maxResults' - The maximum number of results to return.
--
-- 'nextToken', 'getSites_nextToken' - The token for the next page of results.
--
-- 'siteIds', 'getSites_siteIds' - One or more site IDs. The maximum is 10.
--
-- 'globalNetworkId', 'getSites_globalNetworkId' - The ID of the global network.
newGetSites ::
  -- | 'globalNetworkId'
  Prelude.Text ->
  GetSites
newGetSites :: Text -> GetSites
newGetSites Text
pGlobalNetworkId_ =
  GetSites'
    { $sel:maxResults:GetSites' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:GetSites' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:siteIds:GetSites' :: Maybe [Text]
siteIds = forall a. Maybe a
Prelude.Nothing,
      $sel:globalNetworkId:GetSites' :: Text
globalNetworkId = Text
pGlobalNetworkId_
    }

-- | The maximum number of results to return.
getSites_maxResults :: Lens.Lens' GetSites (Prelude.Maybe Prelude.Natural)
getSites_maxResults :: Lens' GetSites (Maybe Natural)
getSites_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSites' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:GetSites' :: GetSites -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: GetSites
s@GetSites' {} Maybe Natural
a -> GetSites
s {$sel:maxResults:GetSites' :: Maybe Natural
maxResults = Maybe Natural
a} :: GetSites)

-- | The token for the next page of results.
getSites_nextToken :: Lens.Lens' GetSites (Prelude.Maybe Prelude.Text)
getSites_nextToken :: Lens' GetSites (Maybe Text)
getSites_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSites' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:GetSites' :: GetSites -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: GetSites
s@GetSites' {} Maybe Text
a -> GetSites
s {$sel:nextToken:GetSites' :: Maybe Text
nextToken = Maybe Text
a} :: GetSites)

-- | One or more site IDs. The maximum is 10.
getSites_siteIds :: Lens.Lens' GetSites (Prelude.Maybe [Prelude.Text])
getSites_siteIds :: Lens' GetSites (Maybe [Text])
getSites_siteIds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSites' {Maybe [Text]
siteIds :: Maybe [Text]
$sel:siteIds:GetSites' :: GetSites -> Maybe [Text]
siteIds} -> Maybe [Text]
siteIds) (\s :: GetSites
s@GetSites' {} Maybe [Text]
a -> GetSites
s {$sel:siteIds:GetSites' :: Maybe [Text]
siteIds = Maybe [Text]
a} :: GetSites) 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 ID of the global network.
getSites_globalNetworkId :: Lens.Lens' GetSites Prelude.Text
getSites_globalNetworkId :: Lens' GetSites Text
getSites_globalNetworkId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSites' {Text
globalNetworkId :: Text
$sel:globalNetworkId:GetSites' :: GetSites -> Text
globalNetworkId} -> Text
globalNetworkId) (\s :: GetSites
s@GetSites' {} Text
a -> GetSites
s {$sel:globalNetworkId:GetSites' :: Text
globalNetworkId = Text
a} :: GetSites)

instance Core.AWSPager GetSites where
  page :: GetSites -> AWSResponse GetSites -> Maybe GetSites
page GetSites
rq AWSResponse GetSites
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse GetSites
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetSitesResponse (Maybe Text)
getSitesResponse_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 GetSites
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetSitesResponse (Maybe [Site])
getSitesResponse_sites
            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.$ GetSites
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' GetSites (Maybe Text)
getSites_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse GetSites
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetSitesResponse (Maybe Text)
getSitesResponse_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 GetSites where
  type AWSResponse GetSites = GetSitesResponse
  request :: (Service -> Service) -> GetSites -> Request GetSites
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 GetSites
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetSites)))
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 Text -> Maybe [Site] -> Int -> GetSitesResponse
GetSitesResponse'
            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
"NextToken")
            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
"Sites" 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 GetSites where
  hashWithSalt :: Int -> GetSites -> Int
hashWithSalt Int
_salt GetSites' {Maybe Natural
Maybe [Text]
Maybe Text
Text
globalNetworkId :: Text
siteIds :: Maybe [Text]
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:globalNetworkId:GetSites' :: GetSites -> Text
$sel:siteIds:GetSites' :: GetSites -> Maybe [Text]
$sel:nextToken:GetSites' :: GetSites -> Maybe Text
$sel:maxResults:GetSites' :: GetSites -> 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
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
siteIds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
globalNetworkId

instance Prelude.NFData GetSites where
  rnf :: GetSites -> ()
rnf GetSites' {Maybe Natural
Maybe [Text]
Maybe Text
Text
globalNetworkId :: Text
siteIds :: Maybe [Text]
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:globalNetworkId:GetSites' :: GetSites -> Text
$sel:siteIds:GetSites' :: GetSites -> Maybe [Text]
$sel:nextToken:GetSites' :: GetSites -> Maybe Text
$sel:maxResults:GetSites' :: GetSites -> 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
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
siteIds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
globalNetworkId

instance Data.ToHeaders GetSites where
  toHeaders :: GetSites -> 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 GetSites where
  toPath :: GetSites -> ByteString
toPath GetSites' {Maybe Natural
Maybe [Text]
Maybe Text
Text
globalNetworkId :: Text
siteIds :: Maybe [Text]
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:globalNetworkId:GetSites' :: GetSites -> Text
$sel:siteIds:GetSites' :: GetSites -> Maybe [Text]
$sel:nextToken:GetSites' :: GetSites -> Maybe Text
$sel:maxResults:GetSites' :: GetSites -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/global-networks/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
globalNetworkId,
        ByteString
"/sites"
      ]

instance Data.ToQuery GetSites where
  toQuery :: GetSites -> QueryString
toQuery GetSites' {Maybe Natural
Maybe [Text]
Maybe Text
Text
globalNetworkId :: Text
siteIds :: Maybe [Text]
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:globalNetworkId:GetSites' :: GetSites -> Text
$sel:siteIds:GetSites' :: GetSites -> Maybe [Text]
$sel:nextToken:GetSites' :: GetSites -> Maybe Text
$sel:maxResults:GetSites' :: GetSites -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"maxResults" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
maxResults,
        ByteString
"nextToken" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nextToken,
        ByteString
"siteIds"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a. ToQuery a => a -> QueryString
Data.toQuery
            (forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"member" forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
siteIds)
      ]

-- | /See:/ 'newGetSitesResponse' smart constructor.
data GetSitesResponse = GetSitesResponse'
  { -- | The token for the next page of results.
    GetSitesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The sites.
    GetSitesResponse -> Maybe [Site]
sites :: Prelude.Maybe [Site],
    -- | The response's http status code.
    GetSitesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetSitesResponse -> GetSitesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetSitesResponse -> GetSitesResponse -> Bool
$c/= :: GetSitesResponse -> GetSitesResponse -> Bool
== :: GetSitesResponse -> GetSitesResponse -> Bool
$c== :: GetSitesResponse -> GetSitesResponse -> Bool
Prelude.Eq, Int -> GetSitesResponse -> ShowS
[GetSitesResponse] -> ShowS
GetSitesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetSitesResponse] -> ShowS
$cshowList :: [GetSitesResponse] -> ShowS
show :: GetSitesResponse -> String
$cshow :: GetSitesResponse -> String
showsPrec :: Int -> GetSitesResponse -> ShowS
$cshowsPrec :: Int -> GetSitesResponse -> ShowS
Prelude.Show, forall x. Rep GetSitesResponse x -> GetSitesResponse
forall x. GetSitesResponse -> Rep GetSitesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetSitesResponse x -> GetSitesResponse
$cfrom :: forall x. GetSitesResponse -> Rep GetSitesResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetSitesResponse' 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:
--
-- 'nextToken', 'getSitesResponse_nextToken' - The token for the next page of results.
--
-- 'sites', 'getSitesResponse_sites' - The sites.
--
-- 'httpStatus', 'getSitesResponse_httpStatus' - The response's http status code.
newGetSitesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetSitesResponse
newGetSitesResponse :: Int -> GetSitesResponse
newGetSitesResponse Int
pHttpStatus_ =
  GetSitesResponse'
    { $sel:nextToken:GetSitesResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:sites:GetSitesResponse' :: Maybe [Site]
sites = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetSitesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The token for the next page of results.
getSitesResponse_nextToken :: Lens.Lens' GetSitesResponse (Prelude.Maybe Prelude.Text)
getSitesResponse_nextToken :: Lens' GetSitesResponse (Maybe Text)
getSitesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSitesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:GetSitesResponse' :: GetSitesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: GetSitesResponse
s@GetSitesResponse' {} Maybe Text
a -> GetSitesResponse
s {$sel:nextToken:GetSitesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: GetSitesResponse)

-- | The sites.
getSitesResponse_sites :: Lens.Lens' GetSitesResponse (Prelude.Maybe [Site])
getSitesResponse_sites :: Lens' GetSitesResponse (Maybe [Site])
getSitesResponse_sites = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSitesResponse' {Maybe [Site]
sites :: Maybe [Site]
$sel:sites:GetSitesResponse' :: GetSitesResponse -> Maybe [Site]
sites} -> Maybe [Site]
sites) (\s :: GetSitesResponse
s@GetSitesResponse' {} Maybe [Site]
a -> GetSitesResponse
s {$sel:sites:GetSitesResponse' :: Maybe [Site]
sites = Maybe [Site]
a} :: GetSitesResponse) 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.
getSitesResponse_httpStatus :: Lens.Lens' GetSitesResponse Prelude.Int
getSitesResponse_httpStatus :: Lens' GetSitesResponse Int
getSitesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSitesResponse' {Int
httpStatus :: Int
$sel:httpStatus:GetSitesResponse' :: GetSitesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: GetSitesResponse
s@GetSitesResponse' {} Int
a -> GetSitesResponse
s {$sel:httpStatus:GetSitesResponse' :: Int
httpStatus = Int
a} :: GetSitesResponse)

instance Prelude.NFData GetSitesResponse where
  rnf :: GetSitesResponse -> ()
rnf GetSitesResponse' {Int
Maybe [Site]
Maybe Text
httpStatus :: Int
sites :: Maybe [Site]
nextToken :: Maybe Text
$sel:httpStatus:GetSitesResponse' :: GetSitesResponse -> Int
$sel:sites:GetSitesResponse' :: GetSitesResponse -> Maybe [Site]
$sel:nextToken:GetSitesResponse' :: GetSitesResponse -> Maybe Text
..} =
    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 Maybe [Site]
sites
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus