{-# 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. connectionId :: Prelude.Maybe Prelude.Text, -- | The ID of the virtual interface. virtualInterfaceId :: Prelude.Maybe Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeVirtualInterfaces' with all optional fields omitted. -- -- Use or 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' { connectionId = Prelude.Nothing, virtualInterfaceId = Prelude.Nothing } -- | The ID of the connection. describeVirtualInterfaces_connectionId :: Lens.Lens' DescribeVirtualInterfaces (Prelude.Maybe Prelude.Text) describeVirtualInterfaces_connectionId = Lens.lens (\DescribeVirtualInterfaces' {connectionId} -> connectionId) (\s@DescribeVirtualInterfaces' {} a -> s {connectionId = a} :: DescribeVirtualInterfaces) -- | The ID of the virtual interface. describeVirtualInterfaces_virtualInterfaceId :: Lens.Lens' DescribeVirtualInterfaces (Prelude.Maybe Prelude.Text) describeVirtualInterfaces_virtualInterfaceId = Lens.lens (\DescribeVirtualInterfaces' {virtualInterfaceId} -> virtualInterfaceId) (\s@DescribeVirtualInterfaces' {} a -> s {virtualInterfaceId = a} :: DescribeVirtualInterfaces) instance Core.AWSRequest DescribeVirtualInterfaces where type AWSResponse DescribeVirtualInterfaces = DescribeVirtualInterfacesResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeVirtualInterfacesResponse' Prelude.<$> ( x Data..?> "virtualInterfaces" Core..!@ Prelude.mempty ) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable DescribeVirtualInterfaces where hashWithSalt _salt DescribeVirtualInterfaces' {..} = _salt `Prelude.hashWithSalt` connectionId `Prelude.hashWithSalt` virtualInterfaceId instance Prelude.NFData DescribeVirtualInterfaces where rnf DescribeVirtualInterfaces' {..} = Prelude.rnf connectionId `Prelude.seq` Prelude.rnf virtualInterfaceId instance Data.ToHeaders DescribeVirtualInterfaces where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "OvertureService.DescribeVirtualInterfaces" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DescribeVirtualInterfaces where toJSON DescribeVirtualInterfaces' {..} = Data.object ( Prelude.catMaybes [ ("connectionId" Data..=) Prelude.<$> connectionId, ("virtualInterfaceId" Data..=) Prelude.<$> virtualInterfaceId ] ) instance Data.ToPath DescribeVirtualInterfaces where toPath = Prelude.const "/" instance Data.ToQuery DescribeVirtualInterfaces where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeVirtualInterfacesResponse' smart constructor. data DescribeVirtualInterfacesResponse = DescribeVirtualInterfacesResponse' { -- | The virtual interfaces virtualInterfaces :: Prelude.Maybe [VirtualInterface], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeVirtualInterfacesResponse' with all optional fields omitted. -- -- Use or 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 pHttpStatus_ = DescribeVirtualInterfacesResponse' { virtualInterfaces = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | The virtual interfaces describeVirtualInterfacesResponse_virtualInterfaces :: Lens.Lens' DescribeVirtualInterfacesResponse (Prelude.Maybe [VirtualInterface]) describeVirtualInterfacesResponse_virtualInterfaces = Lens.lens (\DescribeVirtualInterfacesResponse' {virtualInterfaces} -> virtualInterfaces) (\s@DescribeVirtualInterfacesResponse' {} a -> s {virtualInterfaces = a} :: DescribeVirtualInterfacesResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. describeVirtualInterfacesResponse_httpStatus :: Lens.Lens' DescribeVirtualInterfacesResponse Prelude.Int describeVirtualInterfacesResponse_httpStatus = Lens.lens (\DescribeVirtualInterfacesResponse' {httpStatus} -> httpStatus) (\s@DescribeVirtualInterfacesResponse' {} a -> s {httpStatus = a} :: DescribeVirtualInterfacesResponse) instance Prelude.NFData DescribeVirtualInterfacesResponse where rnf DescribeVirtualInterfacesResponse' {..} = Prelude.rnf virtualInterfaces `Prelude.seq` Prelude.rnf httpStatus