SendSSHPublicKey

$result = $client->sendSSHPublicKey([/* ... */]);
$promise = $client->sendSSHPublicKeyAsync([/* ... */]);

Pushes an SSH public key to the specified EC2 instance for use by the specified user. The key remains for 60 seconds. For more information, see Connect to your Linux instance using EC2 Instance Connect in the Amazon EC2 User Guide.

Parameter Syntax

$result = $client->sendSSHPublicKey([
    'AvailabilityZone' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'InstanceOSUser' => '<string>', // REQUIRED
    'SSHPublicKey' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'Success' => true || false,
]

Result Details

Errors

AuthException:

Either your AWS credentials are not valid or you do not have access to the EC2 instance.

InvalidArgsException:

One of the parameters is not valid.

ServiceException:

The service encountered an error. Follow the instructions in the error message and try again.

ThrottlingException:

The requests were made too frequently and have been throttled. Wait a while and try again. To increase the limit on your request frequency, contact AWS Support.

EC2InstanceNotFoundException:

The specified instance was not found.

EC2InstanceStateInvalidException:

Unable to connect because the instance is not in a valid state. Connecting to a stopped or terminated instance is not supported. If the instance is stopped, start your instance, and try to connect again.

EC2InstanceUnavailableException:

The instance is currently unavailable. Wait a few minutes and try again.

Examples

Example 1: To push an SSH key to an EC2 instance

The following example pushes a sample SSH public key to the EC2 instance i-abcd1234 in AZ us-west-2b for use by the instance OS user ec2-user.

$result = $client->sendSSHPublicKey([
    'AvailabilityZone' => 'us-west-2a', // The zone where the instance was launched
    'InstanceId' => 'i-abcd1234', // The instance ID to publish the key to.
    'InstanceOSUser' => 'ec2-user', // This should be the user you wish to be when ssh-ing to the instance (eg, ec2-user@[instance IP])
    'SSHPublicKey' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC3FlHqj2eqCdrGHuA6dRjfZXQ4HX5lXEIRHaNbxEwE5Te7xNF7StwhrDtiV7IdT5fDqbRyGw/szPj3xGkNTVoElCZ2dDFb2qYZ1WLIpZwj/UhO9l2mgfjR56UojjQut5Jvn2KZ1OcyrNO0J83kCaJCV7JoVbXY79FBMUccYNY45zmv9+1FMCfY6i2jdIhwR6+yLk8oubL8lIPyq7X+6b9S0yKCkB7Peml1DvghlybpAIUrC9vofHt6XP4V1i0bImw1IlljQS+DUmULRFSccATDscCX9ajnj7Crhm0HAZC0tBPXpFdHkPwL3yzYo546SCS9LKEwz62ymxxbL9k7h09t', // This should be in standard OpenSSH format (ssh-rsa [key body])
]);

Result syntax:

[
    'RequestId' => 'abcd1234-abcd-1234-abcd-1234abcd1234', // This request ID should be provided when contacting AWS Support.
    'Success' => 1, // Should be true if the service does not return an error response.
]

SendSerialConsoleSSHPublicKey

$result = $client->sendSerialConsoleSSHPublicKey([/* ... */]);
$promise = $client->sendSerialConsoleSSHPublicKeyAsync([/* ... */]);

Pushes an SSH public key to the specified EC2 instance. The key remains for 60 seconds, which gives you 60 seconds to establish a serial console connection to the instance using SSH. For more information, see EC2 Serial Console in the Amazon EC2 User Guide.

Parameter Syntax

$result = $client->sendSerialConsoleSSHPublicKey([
    'InstanceId' => '<string>', // REQUIRED
    'SSHPublicKey' => '<string>', // REQUIRED
    'SerialPort' => <integer>,
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'Success' => true || false,
]

Result Details

Errors

AuthException:

Either your AWS credentials are not valid or you do not have access to the EC2 instance.

SerialConsoleAccessDisabledException:

Your account is not authorized to use the EC2 Serial Console. To authorize your account, run the EnableSerialConsoleAccess API. For more information, see EnableSerialConsoleAccess in the Amazon EC2 API Reference.

InvalidArgsException:

One of the parameters is not valid.

ServiceException:

The service encountered an error. Follow the instructions in the error message and try again.

ThrottlingException:

The requests were made too frequently and have been throttled. Wait a while and try again. To increase the limit on your request frequency, contact AWS Support.

EC2InstanceNotFoundException:

The specified instance was not found.

EC2InstanceTypeInvalidException:

The instance type is not supported for connecting via the serial console. Only Nitro instance types are currently supported.

SerialConsoleSessionLimitExceededException:

The instance currently has 1 active serial console session. Only 1 session is supported at a time.

SerialConsoleSessionUnavailableException:

Unable to start a serial console session. Please try again.

EC2InstanceStateInvalidException:

Unable to connect because the instance is not in a valid state. Connecting to a stopped or terminated instance is not supported. If the instance is stopped, start your instance, and try to connect again.

EC2InstanceUnavailableException:

The instance is currently unavailable. Wait a few minutes and try again.

SerialConsoleSessionUnsupportedException:

Your instance's BIOS version is unsupported for serial console connection. Reboot your instance to update its BIOS, and then try again to connect.