{-# 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.DescribeVirtualInterfaces
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Displays all virtual interfaces for an Amazon Web Services account.
-- Virtual interfaces deleted fewer than 15 minutes before you make the
-- request are also returned. If you specify a connection ID, only the
-- virtual interfaces associated with the connection are returned. If you
-- specify a virtual interface ID, then only a single virtual interface is
-- returned.
--
-- A virtual interface (VLAN) transmits the traffic between the Direct
-- Connect location and the customer network.
module Amazonka.DirectConnect.DescribeVirtualInterfaces
  ( -- * Creating a Request
    DescribeVirtualInterfaces (..),
    newDescribeVirtualInterfaces,

    -- * Request Lenses
    describeVirtualInterfaces_connectionId,
    describeVirtualInterfaces_virtualInterfaceId,

    -- * Destructuring the Response
    DescribeVirtualInterfacesResponse (..),
    newDescribeVirtualInterfacesResponse,

    -- * Response Lenses
    describeVirtualInterfacesResponse_virtualInterfaces,
    describeVirtualInterfacesResponse_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:/ 'newDescribeVirtualInterfaces' smart constructor.
data DescribeVirtualInterfaces = DescribeVirtualInterfaces'
  { -- | The ID of the connection.
    DescribeVirtualInterfaces -> Maybe Text
connectionId :: Prelude.Maybe Prelude.Text,
    -- | The ID of the virtual interface.
    DescribeVirtualInterfaces -> Maybe Text
virtualInterfaceId :: Prelude.Maybe Prelude.Text
  }
  deriving (DescribeVirtualInterfaces -> DescribeVirtualInterfaces -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeVirtualInterfaces -> DescribeVirtualInterfaces -> Bool
$c/= :: DescribeVirtualInterfaces -> DescribeVirtualInterfaces -> Bool
== :: DescribeVirtualInterfaces -> DescribeVirtualInterfaces -> Bool
$c== :: DescribeVirtualInterfaces -> DescribeVirtualInterfaces -> Bool
Prelude.Eq, ReadPrec [DescribeVirtualInterfaces]
ReadPrec DescribeVirtualInterfaces
Int -> ReadS DescribeVirtualInterfaces
ReadS [DescribeVirtualInterfaces]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeVirtualInterfaces]
$creadListPrec :: ReadPrec [DescribeVirtualInterfaces]
readPrec :: ReadPrec DescribeVirtualInterfaces
$creadPrec :: ReadPrec DescribeVirtualInterfaces
readList :: ReadS [DescribeVirtualInterfaces]
$creadList :: ReadS [DescribeVirtualInterfaces]
readsPrec :: Int -> ReadS DescribeVirtualInterfaces
$creadsPrec :: Int -> ReadS DescribeVirtualInterfaces
Prelude.Read, Int -> DescribeVirtualInterfaces -> ShowS
[DescribeVirtualInterfaces] -> ShowS
DescribeVirtualInterfaces -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeVirtualInterfaces] -> ShowS
$cshowList :: [DescribeVirtualInterfaces] -> ShowS
show :: DescribeVirtualInterfaces -> String
$cshow :: DescribeVirtualInterfaces -> String
showsPrec :: Int -> DescribeVirtualInterfaces -> ShowS
$cshowsPrec :: Int -> DescribeVirtualInterfaces -> ShowS
Prelude.Show, forall x.
Rep DescribeVirtualInterfaces x -> DescribeVirtualInterfaces
forall x.
DescribeVirtualInterfaces -> Rep DescribeVirtualInterfaces x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeVirtualInterfaces x -> DescribeVirtualInterfaces
$cfrom :: forall x.
DescribeVirtualInterfaces -> Rep DescribeVirtualInterfaces x
Prelude.Generic)

-- |
-- Create a value of 'DescribeVirtualInterfaces' 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:
--
-- 'connectionId', 'describeVirtualInterfaces_connectionId' - The ID of the connection.
--
-- 'virtualInterfaceId', 'describeVirtualInterfaces_virtualInterfaceId' - The ID of the virtual interface.
newDescribeVirtualInterfaces ::
  DescribeVirtualInterfaces
newDescribeVirtualInterfaces :: DescribeVirtualInterfaces
newDescribeVirtualInterfaces =
  DescribeVirtualInterfaces'
    { $sel:connectionId:DescribeVirtualInterfaces' :: Maybe Text
connectionId =
        forall a. Maybe a
Prelude.Nothing,
      $sel:virtualInterfaceId:DescribeVirtualInterfaces' :: Maybe Text
virtualInterfaceId = forall a. Maybe a
Prelude.Nothing
    }

-- | The ID of the connection.
describeVirtualInterfaces_connectionId :: Lens.Lens' DescribeVirtualInterfaces (Prelude.Maybe Prelude.Text)
describeVirtualInterfaces_connectionId :: Lens' DescribeVirtualInterfaces (Maybe Text)
describeVirtualInterfaces_connectionId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeVirtualInterfaces' {Maybe Text
connectionId :: Maybe Text
$sel:connectionId:DescribeVirtualInterfaces' :: DescribeVirtualInterfaces -> Maybe Text
connectionId} -> Maybe Text
connectionId) (\s :: DescribeVirtualInterfaces
s@DescribeVirtualInterfaces' {} Maybe Text
a -> DescribeVirtualInterfaces
s {$sel:connectionId:DescribeVirtualInterfaces' :: Maybe Text
connectionId = Maybe Text
a} :: DescribeVirtualInterfaces)

-- | The ID of the virtual interface.
describeVirtualInterfaces_virtualInterfaceId :: Lens.Lens' DescribeVirtualInterfaces (Prelude.Maybe Prelude.Text)
describeVirtualInterfaces_virtualInterfaceId :: Lens' DescribeVirtualInterfaces (Maybe Text)
describeVirtualInterfaces_virtualInterfaceId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeVirtualInterfaces' {Maybe Text
virtualInterfaceId :: Maybe Text
$sel:virtualInterfaceId:DescribeVirtualInterfaces' :: DescribeVirtualInterfaces -> Maybe Text
virtualInterfaceId} -> Maybe Text
virtualInterfaceId) (\s :: DescribeVirtualInterfaces
s@DescribeVirtualInterfaces' {} Maybe Text
a -> DescribeVirtualInterfaces
s {$sel:virtualInterfaceId:DescribeVirtualInterfaces' :: Maybe Text
virtualInterfaceId = Maybe Text
a} :: DescribeVirtualInterfaces)

instance Core.AWSRequest DescribeVirtualInterfaces where
  type
    AWSResponse DescribeVirtualInterfaces =
      DescribeVirtualInterfacesResponse
  request :: (Service -> Service)
-> DescribeVirtualInterfaces -> Request DescribeVirtualInterfaces
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 DescribeVirtualInterfaces
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeVirtualInterfaces)))
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 [VirtualInterface]
-> Int -> DescribeVirtualInterfacesResponse
DescribeVirtualInterfacesResponse'
            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
"virtualInterfaces"
                            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 DescribeVirtualInterfaces where
  hashWithSalt :: Int -> DescribeVirtualInterfaces -> Int
hashWithSalt Int
_salt DescribeVirtualInterfaces' {Maybe Text
virtualInterfaceId :: Maybe Text
connectionId :: Maybe Text
$sel:virtualInterfaceId:DescribeVirtualInterfaces' :: DescribeVirtualInterfaces -> Maybe Text
$sel:connectionId:DescribeVirtualInterfaces' :: DescribeVirtualInterfaces -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
connectionId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
virtualInterfaceId

instance Prelude.NFData DescribeVirtualInterfaces where
  rnf :: DescribeVirtualInterfaces -> ()
rnf DescribeVirtualInterfaces' {Maybe Text
virtualInterfaceId :: Maybe Text
connectionId :: Maybe Text
$sel:virtualInterfaceId:DescribeVirtualInterfaces' :: DescribeVirtualInterfaces -> Maybe Text
$sel:connectionId:DescribeVirtualInterfaces' :: DescribeVirtualInterfaces -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
connectionId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
virtualInterfaceId

instance Data.ToHeaders DescribeVirtualInterfaces where
  toHeaders :: DescribeVirtualInterfaces -> 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.DescribeVirtualInterfaces" ::
                          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 DescribeVirtualInterfaces where
  toJSON :: DescribeVirtualInterfaces -> Value
toJSON DescribeVirtualInterfaces' {Maybe Text
virtualInterfaceId :: Maybe Text
connectionId :: Maybe Text
$sel:virtualInterfaceId:DescribeVirtualInterfaces' :: DescribeVirtualInterfaces -> Maybe Text
$sel:connectionId:DescribeVirtualInterfaces' :: DescribeVirtualInterfaces -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"connectionId" 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
connectionId,
            (Key
"virtualInterfaceId" 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
virtualInterfaceId
          ]
      )

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

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

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

-- |
-- Create a value of 'DescribeVirtualInterfacesResponse' 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:
--
-- 'virtualInterfaces', 'describeVirtualInterfacesResponse_virtualInterfaces' - The virtual interfaces
--
-- 'httpStatus', 'describeVirtualInterfacesResponse_httpStatus' - The response's http status code.
newDescribeVirtualInterfacesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeVirtualInterfacesResponse
newDescribeVirtualInterfacesResponse :: Int -> DescribeVirtualInterfacesResponse
newDescribeVirtualInterfacesResponse Int
pHttpStatus_ =
  DescribeVirtualInterfacesResponse'
    { $sel:virtualInterfaces:DescribeVirtualInterfacesResponse' :: Maybe [VirtualInterface]
virtualInterfaces =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeVirtualInterfacesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The virtual interfaces
describeVirtualInterfacesResponse_virtualInterfaces :: Lens.Lens' DescribeVirtualInterfacesResponse (Prelude.Maybe [VirtualInterface])
describeVirtualInterfacesResponse_virtualInterfaces :: Lens' DescribeVirtualInterfacesResponse (Maybe [VirtualInterface])
describeVirtualInterfacesResponse_virtualInterfaces = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeVirtualInterfacesResponse' {Maybe [VirtualInterface]
virtualInterfaces :: Maybe [VirtualInterface]
$sel:virtualInterfaces:DescribeVirtualInterfacesResponse' :: DescribeVirtualInterfacesResponse -> Maybe [VirtualInterface]
virtualInterfaces} -> Maybe [VirtualInterface]
virtualInterfaces) (\s :: DescribeVirtualInterfacesResponse
s@DescribeVirtualInterfacesResponse' {} Maybe [VirtualInterface]
a -> DescribeVirtualInterfacesResponse
s {$sel:virtualInterfaces:DescribeVirtualInterfacesResponse' :: Maybe [VirtualInterface]
virtualInterfaces = Maybe [VirtualInterface]
a} :: DescribeVirtualInterfacesResponse) 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.
describeVirtualInterfacesResponse_httpStatus :: Lens.Lens' DescribeVirtualInterfacesResponse Prelude.Int
describeVirtualInterfacesResponse_httpStatus :: Lens' DescribeVirtualInterfacesResponse Int
describeVirtualInterfacesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeVirtualInterfacesResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeVirtualInterfacesResponse' :: DescribeVirtualInterfacesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeVirtualInterfacesResponse
s@DescribeVirtualInterfacesResponse' {} Int
a -> DescribeVirtualInterfacesResponse
s {$sel:httpStatus:DescribeVirtualInterfacesResponse' :: Int
httpStatus = Int
a} :: DescribeVirtualInterfacesResponse)

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