ListConnectPeers
Returns a list of core network Connect peers.
Request Syntax
GET /connect-peers?connectAttachmentId=ConnectAttachmentId&coreNetworkId=CoreNetworkId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ConnectAttachmentId
-
The ID of the attachment.
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
^attachment-([0-9a-f]{8,17})$ - CoreNetworkId
-
The ID of a core network.
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
^core-network-([0-9a-f]{8,17})$ - MaxResults
-
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 500.
- NextToken
-
The token for the next page of results.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[\s\S]*
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ConnectPeers": [
{
"ConnectAttachmentId": "string",
"ConnectPeerId": "string",
"ConnectPeerState": "string",
"CoreNetworkId": "string",
"CreatedAt": number,
"EdgeLocation": "string",
"SubnetArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"NextToken": "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.
- ConnectPeers
-
Describes the Connect peers.
Type: Array of ConnectPeerSummary objects
- NextToken
-
The token for the next page of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[\s\S]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request has failed due to an internal error.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
