Network.AWS.DirectConnect.DescribeLoa

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.

Creating a Request

describeLoa

Arguments

:: Text

dlConnectionId

-> DescribeLoa

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

Container for the parameters to the DescribeLoa operation.

See: describeLoa smart constructor.

Instances

Eq DescribeLoa

Methods

(==) :: DescribeLoa -> DescribeLoa -> Bool

(/=) :: DescribeLoa -> DescribeLoa -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS DescribeLoa

readList :: ReadS [DescribeLoa]

readPrec :: ReadPrec DescribeLoa

readListPrec :: ReadPrec [DescribeLoa]

Show DescribeLoa

Methods

showsPrec :: Int -> DescribeLoa -> ShowS

show :: DescribeLoa -> String

showList :: [DescribeLoa] -> ShowS

Generic DescribeLoa

Associated Types

type Rep DescribeLoa :: * -> *

Methods

from :: DescribeLoa -> Rep DescribeLoa x

to :: Rep DescribeLoa x -> DescribeLoa

Hashable DescribeLoa

Methods

hashWithSalt :: Int -> DescribeLoa -> Int

hash :: DescribeLoa -> Int

ToJSON DescribeLoa

Methods

toJSON :: DescribeLoa -> Value

toEncoding :: DescribeLoa -> Encoding

toJSONList :: [DescribeLoa] -> Value

toEncodingList :: [DescribeLoa] -> Encoding

NFData DescribeLoa

Methods

rnf :: DescribeLoa -> ()

AWSRequest DescribeLoa

Associated Types

type Rs DescribeLoa :: *

Methods

request :: DescribeLoa -> Request DescribeLoa

response :: MonadResource m => Logger -> Service -> Proxy * DescribeLoa -> ClientResponse -> m (Response DescribeLoa)

ToQuery DescribeLoa

Methods

toQuery :: DescribeLoa -> QueryString

ToPath DescribeLoa

Methods

toPath :: DescribeLoa -> ByteString

ToHeaders DescribeLoa

Methods

toHeaders :: DescribeLoa -> [Header]

type Rep DescribeLoa

type Rep DescribeLoa = D1 (MetaData "DescribeLoa" "Network.AWS.DirectConnect.DescribeLoa" "amazonka-directconnect-1.5.0-FuyMg4sTg24L6HyEmXEioA" False) (C1 (MetaCons "DescribeLoa'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dlLoaContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LoaContentType))) ((:*:) (S1 (MetaSel (Just Symbol "_dlProviderName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dlConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs DescribeLoa

type Rs DescribeLoa = DescribeLoaResponse

Request Lenses

dlLoaContentType :: Lens' DescribeLoa (Maybe LoaContentType)

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)

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

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

Arguments

:: Int

dlrsResponseStatus

-> DescribeLoaResponse

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

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

See: describeLoaResponse smart constructor.

Instances

Eq DescribeLoaResponse

Methods

(==) :: DescribeLoaResponse -> DescribeLoaResponse -> Bool

(/=) :: DescribeLoaResponse -> DescribeLoaResponse -> Bool

Data DescribeLoaResponse

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

Methods

readsPrec :: Int -> ReadS DescribeLoaResponse

readList :: ReadS [DescribeLoaResponse]

readPrec :: ReadPrec DescribeLoaResponse

readListPrec :: ReadPrec [DescribeLoaResponse]

Show DescribeLoaResponse

Methods

showsPrec :: Int -> DescribeLoaResponse -> ShowS

show :: DescribeLoaResponse -> String

showList :: [DescribeLoaResponse] -> ShowS

Generic DescribeLoaResponse

Associated Types

type Rep DescribeLoaResponse :: * -> *

Methods

from :: DescribeLoaResponse -> Rep DescribeLoaResponse x

to :: Rep DescribeLoaResponse x -> DescribeLoaResponse

NFData DescribeLoaResponse

Methods

rnf :: DescribeLoaResponse -> ()

type Rep DescribeLoaResponse

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

Response Lenses

dlrsLoaContent :: Lens' DescribeLoaResponse (Maybe ByteString)

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 :: Lens' DescribeLoaResponse (Maybe LoaContentType)

Undocumented member.

dlrsResponseStatus :: Lens' DescribeLoaResponse Int

• - | The response status code.