DescribeLoa
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 AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.
Request Syntax
{
"connectionId": "string",
"loaContentType": "string",
"providerName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- connectionId
-
The ID of a connection, LAG, or interconnect.
Type: String
Required: Yes
- loaContentType
-
The standard media type for the LOA-CFA document. The only supported value is application/pdf.
Type: String
Valid Values:
application/pdfRequired: No
- 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.
Type: String
Required: No
Response Syntax
{
"loaContent": blob,
"loaContentType": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- loaContent
-
The binary contents of the LOA-CFA document.
Type: Base64-encoded binary data object
- loaContentType
-
The standard media type for the LOA-CFA document. The only supported value is application/pdf.
Type: String
Valid Values:
application/pdf
Errors
For information about the errors that are common to all actions, see Common Errors.
- DirectConnectClientException
-
One or more parameters are not valid.
HTTP Status Code: 400
- DirectConnectServerException
-
A server-side error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
