GetConnectPeer
Returns information about a core network Connect peer.
Request Syntax
GET /connect-peers/connectPeerId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- connectPeerId
-
The ID of the Connect peer.
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
^connect-peer-([0-9a-f]{8,17})$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ConnectPeer": {
"Configuration": {
"BgpConfigurations": [
{
"CoreNetworkAddress": "string",
"CoreNetworkAsn": number,
"PeerAddress": "string",
"PeerAsn": number
}
],
"CoreNetworkAddress": "string",
"InsideCidrBlocks": [ "string" ],
"PeerAddress": "string",
"Protocol": "string"
},
"ConnectAttachmentId": "string",
"ConnectPeerId": "string",
"CoreNetworkId": "string",
"CreatedAt": number,
"EdgeLocation": "string",
"LastModificationErrors": [
{
"Code": "string",
"Message": "string",
"RequestId": "string",
"ResourceArn": "string"
}
],
"State": "string",
"SubnetArn": "string",
"Tags": [
{
"Key": "string",
"Value": "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.
- ConnectPeer
-
Returns information about a core network Connect peer.
Type: ConnectPeer object
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
- ResourceNotFoundException
-
The specified resource could not be found.
HTTP Status Code: 404
- 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: