GetConnection
Note
AWS uses this action to install Outpost servers.
Gets information about the specified connection.
Use CloudTrail to monitor this action or AWS managed policy for AWS Outposts to secure it. For more information, see AWS managed policies for AWS Outposts and Logging AWS Outposts API calls with AWS CloudTrail in the AWS Outposts User Guide.
Request Syntax
GET /connections/ConnectionId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ConnectionId
-
The ID of the connection.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[a-zA-Z0-9+/=]{1,1024}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ConnectionDetails": {
"AllowedIps": [ "string" ],
"ClientPublicKey": "string",
"ClientTunnelAddress": "string",
"ServerEndpoint": "string",
"ServerPublicKey": "string",
"ServerTunnelAddress": "string"
},
"ConnectionId": "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.
- ConnectionDetails
-
Information about the connection.
Type: ConnectionDetails object
- ConnectionId
-
The ID of the connection.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[a-zA-Z0-9+/=]{1,1024}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have permission to perform this operation.
HTTP Status Code: 403
- InternalServerException
-
An internal error has occurred.
HTTP Status Code: 500
- NotFoundException
-
The specified request is not valid.
HTTP Status Code: 404
- ValidationException
-
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: