Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DirectConnect.DescribeLoa

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets 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 Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

Creating a Request

data DescribeLoa Source #

See: newDescribeLoa smart constructor.

Constructors

DescribeLoa'

Fields

loaContentType :: Maybe LoaContentType
The standard media type for the LOA-CFA document. The only supported value is application/pdf.
providerName :: Maybe Text
The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.
connectionId :: Text
The ID of a connection, LAG, or interconnect.

Instances

Instances details

ToJSON DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods toJSON :: DescribeLoa -> Value # toEncoding :: DescribeLoa -> Encoding # toJSONList :: [DescribeLoa] -> Value # toEncodingList :: [DescribeLoa] -> Encoding #
ToHeaders DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods toHeaders :: DescribeLoa -> [Header] #
ToPath DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods toPath :: DescribeLoa -> ByteString #
ToQuery DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods toQuery :: DescribeLoa -> QueryString #
AWSRequest DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Associated Types type AWSResponse DescribeLoa # Methods request :: (Service -> Service) -> DescribeLoa -> Request DescribeLoa # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeLoa -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeLoa))) #
Generic DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Associated Types type Rep DescribeLoa :: Type -> Type # Methods from :: DescribeLoa -> Rep DescribeLoa x # to :: Rep DescribeLoa x -> DescribeLoa #
Read DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods readsPrec :: Int -> ReadS DescribeLoa # readList :: ReadS [DescribeLoa] # readPrec :: ReadPrec DescribeLoa # readListPrec :: ReadPrec [DescribeLoa] #
Show DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods showsPrec :: Int -> DescribeLoa -> ShowS # show :: DescribeLoa -> String # showList :: [DescribeLoa] -> ShowS #
NFData DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods rnf :: DescribeLoa -> () #
Eq DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods (==) :: DescribeLoa -> DescribeLoa -> Bool # (/=) :: DescribeLoa -> DescribeLoa -> Bool #
Hashable DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods hashWithSalt :: Int -> DescribeLoa -> Int # hash :: DescribeLoa -> Int #
type AWSResponse DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa type AWSResponse DescribeLoa = DescribeLoaResponse
type Rep DescribeLoa Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa type Rep DescribeLoa = D1 ('MetaData "DescribeLoa" "Amazonka.DirectConnect.DescribeLoa" "amazonka-directconnect-2.0-L3DT8JGnMceEIS37MHoczF" 'False) (C1 ('MetaCons "DescribeLoa'" 'PrefixI 'True) (S1 ('MetaSel ('Just "loaContentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoaContentType)) :: (S1 ('MetaSel ('Just "providerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeLoa Source #

Arguments

:: Text	`DescribeLoa`
-> DescribeLoa

Create a value of DescribeLoa with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeLoa, describeLoa_loaContentType - The standard media type for the LOA-CFA document. The only supported value is application/pdf.

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

DescribeLoa, describeLoa_connectionId - The ID of a connection, LAG, or interconnect.

Request Lenses

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

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

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

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

describeLoa_connectionId :: Lens' DescribeLoa Text Source #

The ID of a connection, LAG, or interconnect.

Destructuring the Response

data DescribeLoaResponse Source #

Information about a Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.

See: newDescribeLoaResponse smart constructor.

Constructors

DescribeLoaResponse'
Fields loaContent :: Maybe Base64 The binary contents of the LOA-CFA document. loaContentType :: Maybe LoaContentType The standard media type for the LOA-CFA document. The only supported value is application/pdf. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeLoaResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Associated Types type Rep DescribeLoaResponse :: Type -> Type # Methods from :: DescribeLoaResponse -> Rep DescribeLoaResponse x # to :: Rep DescribeLoaResponse x -> DescribeLoaResponse #
Read DescribeLoaResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods readsPrec :: Int -> ReadS DescribeLoaResponse # readList :: ReadS [DescribeLoaResponse] # readPrec :: ReadPrec DescribeLoaResponse # readListPrec :: ReadPrec [DescribeLoaResponse] #
Show DescribeLoaResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods showsPrec :: Int -> DescribeLoaResponse -> ShowS # show :: DescribeLoaResponse -> String # showList :: [DescribeLoaResponse] -> ShowS #
NFData DescribeLoaResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods rnf :: DescribeLoaResponse -> () #
Eq DescribeLoaResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa Methods (==) :: DescribeLoaResponse -> DescribeLoaResponse -> Bool # (/=) :: DescribeLoaResponse -> DescribeLoaResponse -> Bool #
type Rep DescribeLoaResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeLoa type Rep DescribeLoaResponse = D1 ('MetaData "DescribeLoaResponse" "Amazonka.DirectConnect.DescribeLoa" "amazonka-directconnect-2.0-L3DT8JGnMceEIS37MHoczF" 'False) (C1 ('MetaCons "DescribeLoaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "loaContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :: (S1 ('MetaSel ('Just "loaContentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoaContentType)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeLoaResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeLoaResponse'`
-> DescribeLoaResponse

Create a value of DescribeLoaResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:loaContent:DescribeLoaResponse', describeLoaResponse_loaContent - The binary contents of the LOA-CFA document.-- -- 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.

DescribeLoa, describeLoaResponse_loaContentType - The standard media type for the LOA-CFA document. The only supported value is application/pdf.

$sel:httpStatus:DescribeLoaResponse', describeLoaResponse_httpStatus - The response's http status code.

Response Lenses

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

The binary contents of the LOA-CFA document.-- -- 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.

describeLoaResponse_loaContentType :: Lens' DescribeLoaResponse (Maybe LoaContentType) Source #

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

describeLoaResponse_httpStatus :: Lens' DescribeLoaResponse Int Source #

The response's http status code.