We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Protected
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
Intended for use by Direct Connect Partners only.
Use a bare-bones client and the command you need to make an API call.
import { DirectConnectClient, DescribeHostedConnectionsCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import// const { DirectConnectClient, DescribeHostedConnectionsCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS importconst client = new DirectConnectClient(config);const input = { // DescribeHostedConnectionsRequest connectionId: "STRING_VALUE", // required};const command = new DescribeHostedConnectionsCommand(input);const response = await client.send(command);// { // Connections// connections: [ // ConnectionList// { // Connection// ownerAccount: "STRING_VALUE",// connectionId: "STRING_VALUE",// connectionName: "STRING_VALUE",// connectionState: "ordering" || "requested" || "pending" || "available" || "down" || "deleting" || "deleted" || "rejected" || "unknown",// region: "STRING_VALUE",// location: "STRING_VALUE",// bandwidth: "STRING_VALUE",// vlan: Number("int"),// partnerName: "STRING_VALUE",// loaIssueTime: new Date("TIMESTAMP"),// lagId: "STRING_VALUE",// awsDevice: "STRING_VALUE",// jumboFrameCapable: true || false,// awsDeviceV2: "STRING_VALUE",// awsLogicalDeviceId: "STRING_VALUE",// hasLogicalRedundancy: "unknown" || "yes" || "no",// tags: [ // TagList// { // Tag// key: "STRING_VALUE", // required// value: "STRING_VALUE",// },// ],// providerName: "STRING_VALUE",// macSecCapable: true || false,// portEncryptionStatus: "STRING_VALUE",// encryptionMode: "STRING_VALUE",// macSecKeys: [ // MacSecKeyList// { // MacSecKey// secretARN: "STRING_VALUE",// ckn: "STRING_VALUE",// state: "STRING_VALUE",// startOn: "STRING_VALUE",// },// ],// },// ],// };
DescribeHostedConnectionsCommandInput
DescribeHostedConnectionsCommandOutput
input
response
config
DirectConnectClientException (client fault)
One or more parameters are not valid.
DirectConnectServerException (server fault)
A server-side error occurred.
DirectConnectServiceException
Base exception class for all service exceptions from DirectConnect service.
Readonly
Static
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
Intended for use by Direct Connect Partners only.
Example
Use a bare-bones client and the command you need to make an API call.
Param
DescribeHostedConnectionsCommandInput
Returns
DescribeHostedConnectionsCommandOutput
See
input
shape.response
shape.config
shape.Throws
DirectConnectClientException (client fault)
One or more parameters are not valid.
Throws
DirectConnectServerException (server fault)
A server-side error occurred.
Throws
DirectConnectServiceException
Base exception class for all service exceptions from DirectConnect service.