StartConnection
Note
AWS uses this action to install Outpost servers.
Starts the connection required for Outpost server installation.
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
POST /connections HTTP/1.1
Content-type: application/json
{
"AssetId": "string",
"ClientPublicKey": "string",
"DeviceSerialNumber": "string",
"NetworkInterfaceDeviceIndex": number
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- AssetId
-
The ID of the Outpost server.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^(\w+)$Required: Yes
- ClientPublicKey
-
The public key of the client.
Type: String
Length Constraints: Fixed length of 44.
Pattern:
^[a-zA-Z0-9/+]{43}=$Required: Yes
- DeviceSerialNumber
-
The serial number of the dongle.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^(\w+)$Required: Yes
- NetworkInterfaceDeviceIndex
-
The device index of the network interface on the Outpost server.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ConnectionId": "string",
"UnderlayIpAddress": "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.
- 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}$ - UnderlayIpAddress
-
The underlay IP address.
Type: String
Length Constraints: Minimum length of 7. Maximum length of 15.
Pattern:
^([0-9]{1,3}\.){3}[0-9]{1,3}$
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:
