{-# 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.DirectConnect.DescribeVirtualGateways
-- 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 the virtual private gateways owned by the Amazon Web Services
-- account.
--
-- You can create one or more Direct Connect private virtual interfaces
-- linked to a virtual private gateway.
module Amazonka.DirectConnect.DescribeVirtualGateways
  ( -- * Creating a Request
    DescribeVirtualGateways (..),
    newDescribeVirtualGateways,

    -- * Destructuring the Response
    DescribeVirtualGatewaysResponse (..),
    newDescribeVirtualGatewaysResponse,

    -- * Response Lenses
    describeVirtualGatewaysResponse_virtualGateways,
    describeVirtualGatewaysResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeVirtualGateways' smart constructor.
data DescribeVirtualGateways = DescribeVirtualGateways'
  {
  }
  deriving (DescribeVirtualGateways -> DescribeVirtualGateways -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeVirtualGateways -> DescribeVirtualGateways -> Bool
$c/= :: DescribeVirtualGateways -> DescribeVirtualGateways -> Bool
== :: DescribeVirtualGateways -> DescribeVirtualGateways -> Bool
$c== :: DescribeVirtualGateways -> DescribeVirtualGateways -> Bool
Prelude.Eq, ReadPrec [DescribeVirtualGateways]
ReadPrec DescribeVirtualGateways
Int -> ReadS DescribeVirtualGateways
ReadS [DescribeVirtualGateways]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeVirtualGateways]
$creadListPrec :: ReadPrec [DescribeVirtualGateways]
readPrec :: ReadPrec DescribeVirtualGateways
$creadPrec :: ReadPrec DescribeVirtualGateways
readList :: ReadS [DescribeVirtualGateways]
$creadList :: ReadS [DescribeVirtualGateways]
readsPrec :: Int -> ReadS DescribeVirtualGateways
$creadsPrec :: Int -> ReadS DescribeVirtualGateways
Prelude.Read, Int -> DescribeVirtualGateways -> ShowS
[DescribeVirtualGateways] -> ShowS
DescribeVirtualGateways -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeVirtualGateways] -> ShowS
$cshowList :: [DescribeVirtualGateways] -> ShowS
show :: DescribeVirtualGateways -> String
$cshow :: DescribeVirtualGateways -> String
showsPrec :: Int -> DescribeVirtualGateways -> ShowS
$cshowsPrec :: Int -> DescribeVirtualGateways -> ShowS
Prelude.Show, forall x. Rep DescribeVirtualGateways x -> DescribeVirtualGateways
forall x. DescribeVirtualGateways -> Rep DescribeVirtualGateways x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeVirtualGateways x -> DescribeVirtualGateways
$cfrom :: forall x. DescribeVirtualGateways -> Rep DescribeVirtualGateways x
Prelude.Generic)

-- |
-- Create a value of 'DescribeVirtualGateways' 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.
newDescribeVirtualGateways ::
  DescribeVirtualGateways
newDescribeVirtualGateways :: DescribeVirtualGateways
newDescribeVirtualGateways = DescribeVirtualGateways
DescribeVirtualGateways'

instance Core.AWSRequest DescribeVirtualGateways where
  type
    AWSResponse DescribeVirtualGateways =
      DescribeVirtualGatewaysResponse
  request :: (Service -> Service)
-> DescribeVirtualGateways -> Request DescribeVirtualGateways
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 DescribeVirtualGateways
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeVirtualGateways)))
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 [VirtualGateway] -> Int -> DescribeVirtualGatewaysResponse
DescribeVirtualGatewaysResponse'
            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
"virtualGateways"
                            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 DescribeVirtualGateways where
  hashWithSalt :: Int -> DescribeVirtualGateways -> Int
hashWithSalt Int
_salt DescribeVirtualGateways
_ =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ()

instance Prelude.NFData DescribeVirtualGateways where
  rnf :: DescribeVirtualGateways -> ()
rnf DescribeVirtualGateways
_ = ()

instance Data.ToHeaders DescribeVirtualGateways where
  toHeaders :: DescribeVirtualGateways -> 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
"OvertureService.DescribeVirtualGateways" ::
                          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 DescribeVirtualGateways where
  toJSON :: DescribeVirtualGateways -> Value
toJSON = forall a b. a -> b -> a
Prelude.const (Object -> Value
Data.Object forall a. Monoid a => a
Prelude.mempty)

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

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

-- | /See:/ 'newDescribeVirtualGatewaysResponse' smart constructor.
data DescribeVirtualGatewaysResponse = DescribeVirtualGatewaysResponse'
  { -- | The virtual private gateways.
    DescribeVirtualGatewaysResponse -> Maybe [VirtualGateway]
virtualGateways :: Prelude.Maybe [VirtualGateway],
    -- | The response's http status code.
    DescribeVirtualGatewaysResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeVirtualGatewaysResponse
-> DescribeVirtualGatewaysResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeVirtualGatewaysResponse
-> DescribeVirtualGatewaysResponse -> Bool
$c/= :: DescribeVirtualGatewaysResponse
-> DescribeVirtualGatewaysResponse -> Bool
== :: DescribeVirtualGatewaysResponse
-> DescribeVirtualGatewaysResponse -> Bool
$c== :: DescribeVirtualGatewaysResponse
-> DescribeVirtualGatewaysResponse -> Bool
Prelude.Eq, ReadPrec [DescribeVirtualGatewaysResponse]
ReadPrec DescribeVirtualGatewaysResponse
Int -> ReadS DescribeVirtualGatewaysResponse
ReadS [DescribeVirtualGatewaysResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeVirtualGatewaysResponse]
$creadListPrec :: ReadPrec [DescribeVirtualGatewaysResponse]
readPrec :: ReadPrec DescribeVirtualGatewaysResponse
$creadPrec :: ReadPrec DescribeVirtualGatewaysResponse
readList :: ReadS [DescribeVirtualGatewaysResponse]
$creadList :: ReadS [DescribeVirtualGatewaysResponse]
readsPrec :: Int -> ReadS DescribeVirtualGatewaysResponse
$creadsPrec :: Int -> ReadS DescribeVirtualGatewaysResponse
Prelude.Read, Int -> DescribeVirtualGatewaysResponse -> ShowS
[DescribeVirtualGatewaysResponse] -> ShowS
DescribeVirtualGatewaysResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeVirtualGatewaysResponse] -> ShowS
$cshowList :: [DescribeVirtualGatewaysResponse] -> ShowS
show :: DescribeVirtualGatewaysResponse -> String
$cshow :: DescribeVirtualGatewaysResponse -> String
showsPrec :: Int -> DescribeVirtualGatewaysResponse -> ShowS
$cshowsPrec :: Int -> DescribeVirtualGatewaysResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeVirtualGatewaysResponse x
-> DescribeVirtualGatewaysResponse
forall x.
DescribeVirtualGatewaysResponse
-> Rep DescribeVirtualGatewaysResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeVirtualGatewaysResponse x
-> DescribeVirtualGatewaysResponse
$cfrom :: forall x.
DescribeVirtualGatewaysResponse
-> Rep DescribeVirtualGatewaysResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeVirtualGatewaysResponse' 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:
--
-- 'virtualGateways', 'describeVirtualGatewaysResponse_virtualGateways' - The virtual private gateways.
--
-- 'httpStatus', 'describeVirtualGatewaysResponse_httpStatus' - The response's http status code.
newDescribeVirtualGatewaysResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeVirtualGatewaysResponse
newDescribeVirtualGatewaysResponse :: Int -> DescribeVirtualGatewaysResponse
newDescribeVirtualGatewaysResponse Int
pHttpStatus_ =
  DescribeVirtualGatewaysResponse'
    { $sel:virtualGateways:DescribeVirtualGatewaysResponse' :: Maybe [VirtualGateway]
virtualGateways =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeVirtualGatewaysResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The virtual private gateways.
describeVirtualGatewaysResponse_virtualGateways :: Lens.Lens' DescribeVirtualGatewaysResponse (Prelude.Maybe [VirtualGateway])
describeVirtualGatewaysResponse_virtualGateways :: Lens' DescribeVirtualGatewaysResponse (Maybe [VirtualGateway])
describeVirtualGatewaysResponse_virtualGateways = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeVirtualGatewaysResponse' {Maybe [VirtualGateway]
virtualGateways :: Maybe [VirtualGateway]
$sel:virtualGateways:DescribeVirtualGatewaysResponse' :: DescribeVirtualGatewaysResponse -> Maybe [VirtualGateway]
virtualGateways} -> Maybe [VirtualGateway]
virtualGateways) (\s :: DescribeVirtualGatewaysResponse
s@DescribeVirtualGatewaysResponse' {} Maybe [VirtualGateway]
a -> DescribeVirtualGatewaysResponse
s {$sel:virtualGateways:DescribeVirtualGatewaysResponse' :: Maybe [VirtualGateway]
virtualGateways = Maybe [VirtualGateway]
a} :: DescribeVirtualGatewaysResponse) 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.
describeVirtualGatewaysResponse_httpStatus :: Lens.Lens' DescribeVirtualGatewaysResponse Prelude.Int
describeVirtualGatewaysResponse_httpStatus :: Lens' DescribeVirtualGatewaysResponse Int
describeVirtualGatewaysResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeVirtualGatewaysResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeVirtualGatewaysResponse' :: DescribeVirtualGatewaysResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeVirtualGatewaysResponse
s@DescribeVirtualGatewaysResponse' {} Int
a -> DescribeVirtualGatewaysResponse
s {$sel:httpStatus:DescribeVirtualGatewaysResponse' :: Int
httpStatus = Int
a} :: DescribeVirtualGatewaysResponse)

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