Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetInstanceAccessDetails

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

Request Syntax


{
   "instanceName": "string",
   "protocol": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

instanceName

The name of the instance to access.

Type: String

Pattern: \w[\w\-]*\w

Required: Yes

protocol

The protocol to use to connect to your instance. Defaults to ssh.

Type: String

Valid Values: ssh | rdp

Required: No

Response Syntax


{
   "accessDetails": { 
      "certKey": "string",
      "expiresAt": number,
      "hostKeys": [ 
         { 
            "algorithm": "string",
            "fingerprintSHA1": "string",
            "fingerprintSHA256": "string",
            "notValidAfter": number,
            "notValidBefore": number,
            "publicKey": "string",
            "witnessedAt": number
         }
      ],
      "instanceName": "string",
      "ipAddress": "string",
      "ipv6Addresses": [ "string" ],
      "password": "string",
      "passwordData": { 
         "ciphertext": "string",
         "keyPairName": "string"
      },
      "privateKey": "string",
      "protocol": "string",
      "username": "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.

accessDetails

An array of key-value pairs containing information about a get instance access request.

Type: InstanceAccessDetails object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

AccountSetupInProgressException

Lightsail throws this exception when an account is still in the setup in progress state.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

OperationFailureException

Lightsail throws this exception when an operation fails to execute.

HTTP Status Code: 400

RegionSetupInProgressException

Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.

docs: Regions and Availability Zones for Lightsail
tip: Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400