amazonka-directconnect-1.6.1: Amazon Direct Connect SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DirectConnect.DescribeLoa

Contents

Description

Returns the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect user guide.

Synopsis

Creating a Request

describeLoa Source #

Creates a value of DescribeLoa with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dlLoaContentType - A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is "applicationpdf". Default: applicationpdf
  • dlProviderName - The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. Default: None
  • dlConnectionId - The ID of a connection, LAG, or interconnect for which to get the LOA-CFA information. Example: dxcon-abc123 or dxlag-abc123 Default: None

data DescribeLoa Source #

Container for the parameters to the DescribeLoa operation.

See: describeLoa smart constructor.

Instances
Eq DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Data DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeLoa -> c DescribeLoa #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeLoa #

toConstr :: DescribeLoa -> Constr #

dataTypeOf :: DescribeLoa -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeLoa) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeLoa) #

gmapT :: (forall b. Data b => b -> b) -> DescribeLoa -> DescribeLoa #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLoa -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLoa -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeLoa -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeLoa -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeLoa -> m DescribeLoa #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLoa -> m DescribeLoa #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLoa -> m DescribeLoa #

Read DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Show DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Generic DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Associated Types

type Rep DescribeLoa :: Type -> Type #

Hashable DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

ToJSON DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

AWSRequest DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Associated Types

type Rs DescribeLoa :: Type #

ToHeaders DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Methods

toHeaders :: DescribeLoa -> [Header] #

ToPath DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

ToQuery DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

NFData DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Methods

rnf :: DescribeLoa -> () #

type Rep DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

type Rep DescribeLoa = D1 (MetaData "DescribeLoa" "Network.AWS.DirectConnect.DescribeLoa" "amazonka-directconnect-1.6.1-Jjw4CKEcom3TDRFDWXGnu" False) (C1 (MetaCons "DescribeLoa'" PrefixI True) (S1 (MetaSel (Just "_dlLoaContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LoaContentType)) :*: (S1 (MetaSel (Just "_dlProviderName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dlConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs DescribeLoa Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Request Lenses

dlLoaContentType :: Lens' DescribeLoa (Maybe LoaContentType) Source #

A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is "applicationpdf". Default: applicationpdf

dlProviderName :: Lens' DescribeLoa (Maybe Text) Source #

The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. Default: None

dlConnectionId :: Lens' DescribeLoa Text Source #

The ID of a connection, LAG, or interconnect for which to get the LOA-CFA information. Example: dxcon-abc123 or dxlag-abc123 Default: None

Destructuring the Response

describeLoaResponse Source #

Creates a value of DescribeLoaResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dlrsLoaContent - Undocumented member.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
  • dlrsLoaContentType - Undocumented member.
  • dlrsResponseStatus - -- | The response status code.

data DescribeLoaResponse Source #

A structure containing the Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.

See: describeLoaResponse smart constructor.

Instances
Eq DescribeLoaResponse Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Data DescribeLoaResponse Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeLoaResponse -> c DescribeLoaResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeLoaResponse #

toConstr :: DescribeLoaResponse -> Constr #

dataTypeOf :: DescribeLoaResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeLoaResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeLoaResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeLoaResponse -> DescribeLoaResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLoaResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLoaResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeLoaResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeLoaResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeLoaResponse -> m DescribeLoaResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLoaResponse -> m DescribeLoaResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLoaResponse -> m DescribeLoaResponse #

Read DescribeLoaResponse Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Show DescribeLoaResponse Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Generic DescribeLoaResponse Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Associated Types

type Rep DescribeLoaResponse :: Type -> Type #

NFData DescribeLoaResponse Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

Methods

rnf :: DescribeLoaResponse -> () #

type Rep DescribeLoaResponse Source # 
Instance details

Defined in Network.AWS.DirectConnect.DescribeLoa

type Rep DescribeLoaResponse = D1 (MetaData "DescribeLoaResponse" "Network.AWS.DirectConnect.DescribeLoa" "amazonka-directconnect-1.6.1-Jjw4CKEcom3TDRFDWXGnu" False) (C1 (MetaCons "DescribeLoaResponse'" PrefixI True) (S1 (MetaSel (Just "_dlrsLoaContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Base64)) :*: (S1 (MetaSel (Just "_dlrsLoaContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LoaContentType)) :*: S1 (MetaSel (Just "_dlrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dlrsLoaContent :: Lens' DescribeLoaResponse (Maybe ByteString) Source #

Undocumented member.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

dlrsResponseStatus :: Lens' DescribeLoaResponse Int Source #

  • - | The response status code.