- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeInterconnectLoaCommand
Deprecated. Use DescribeLoa instead.
Gets the LOA-CFA for the specified interconnect.
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DirectConnectClient, DescribeInterconnectLoaCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, DescribeInterconnectLoaCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const input = { // DescribeInterconnectLoaRequest
interconnectId: "STRING_VALUE", // required
providerName: "STRING_VALUE",
loaContentType: "application/pdf",
};
const command = new DescribeInterconnectLoaCommand(input);
const response = await client.send(command);
// { // DescribeInterconnectLoaResponse
// loa: { // Loa
// loaContent: new Uint8Array(),
// loaContentType: "application/pdf",
// },
// };
DescribeInterconnectLoaCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
interconnectIdRequired | string | undefined | The ID of the interconnect. |
loaContentType | LoaContentType | undefined | The standard media type for the LOA-CFA document. The only supported value is application/pdf. |
providerName | string | undefined | 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. |
DescribeInterconnectLoaCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
loa | Loa | undefined | The Letter of Authorization - Connecting Facility Assignment (LOA-CFA). |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| DirectConnectClientException | client | One or more parameters are not valid. |
| DirectConnectServerException | server | A server-side error occurred. |
| DirectConnectServiceException | Base exception class for all service exceptions from DirectConnect service. |