ListConnectPeersCommand

Suggest an Edit

Returns a list of core network Connect peers.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NetworkManagerClient, ListConnectPeersCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import
// const { NetworkManagerClient, ListConnectPeersCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import
const client = new NetworkManagerClient(config);
const input = { // ListConnectPeersRequest
  CoreNetworkId: "STRING_VALUE",
  ConnectAttachmentId: "STRING_VALUE",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListConnectPeersCommand(input);
const response = await client.send(command);
// { // ListConnectPeersResponse
//   ConnectPeers: [ // ConnectPeerSummaryList
//     { // ConnectPeerSummary
//       CoreNetworkId: "STRING_VALUE",
//       ConnectAttachmentId: "STRING_VALUE",
//       ConnectPeerId: "STRING_VALUE",
//       EdgeLocation: "STRING_VALUE",
//       ConnectPeerState: "CREATING" || "FAILED" || "AVAILABLE" || "DELETING",
//       CreatedAt: new Date("TIMESTAMP"),
//       Tags: [ // TagList
//         { // Tag
//           Key: "STRING_VALUE",
//           Value: "STRING_VALUE",
//         },
//       ],
//       SubnetArn: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListConnectPeersCommand Input

See ListConnectPeersCommandInput for more details

Parameter
Type
Description
ConnectAttachmentId
string | undefined

The ID of the attachment.

CoreNetworkId
string | undefined

The ID of a core network.

MaxResults
number | undefined

The maximum number of results to return.

NextToken
string | undefined

The token for the next page of results.

ListConnectPeersCommand Output

See ListConnectPeersCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ConnectPeers
ConnectPeerSummary[] | undefined

Describes the Connect peers.

NextToken
string | undefined

The token for the next page of results.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed due to an internal error.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints.

NetworkManagerServiceException
Base exception class for all service exceptions from NetworkManager service.