AWS EC2 Instance Connect 2018-04-02
- Client: Aws\EC2InstanceConnect\EC2InstanceConnectClient
- Service ID: ec2-instance-connect
- Version: 2018-04-02
This page describes the parameters and results for the operations of the AWS EC2 Instance Connect (2018-04-02), and shows how to use the Aws\EC2InstanceConnect\EC2InstanceConnectClient object to call the described operations. This documentation is specific to the 2018-04-02 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- SendSSHPublicKey ( array $params = [] )
Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.
Operations
SendSSHPublicKey
$result = $client->sendSSHPublicKey([/* ... */]); $promise = $client->sendSSHPublicKeyAsync([/* ... */]);
Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.
Parameter Syntax
$result = $client->sendSSHPublicKey([
'AvailabilityZone' => '<string>', // REQUIRED
'InstanceId' => '<string>', // REQUIRED
'InstanceOSUser' => '<string>', // REQUIRED
'SSHPublicKey' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AvailabilityZone
-
- Required: Yes
- Type: string
The availability zone the EC2 instance was launched in.
- InstanceId
-
- Required: Yes
- Type: string
The EC2 instance you wish to publish the SSH key to.
- InstanceOSUser
-
- Required: Yes
- Type: string
The OS user on the EC2 instance whom the key may be used to authenticate as.
- SSHPublicKey
-
- Required: Yes
- Type: string
The public key to be published to the instance. To use it after publication you must have the matching private key.
Result Syntax
[
'RequestId' => '<string>',
'Success' => true || false,
]
Result Details
Members
Errors
-
Indicates that either your AWS credentials are invalid or you do not have access to the EC2 instance.
-
Indicates that you provided bad input. Ensure you have a valid instance ID, the correct zone, and a valid SSH public key.
-
Indicates that the service encountered an error. Follow the message's instructions and try again.
-
Indicates you have been making requests too frequently and have been throttled. Wait for a while and try again. If higher call volume is warranted contact AWS Support.
-
Indicates that the instance requested was not found in the given zone. Check that you have provided a valid instance ID and the correct zone.
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.
]
Shapes
AuthException
Description
Indicates that either your AWS credentials are invalid or you do not have access to the EC2 instance.
Members
EC2InstanceNotFoundException
Description
Indicates that the instance requested was not found in the given zone. Check that you have provided a valid instance ID and the correct zone.
Members
InvalidArgsException
Description
Indicates that you provided bad input. Ensure you have a valid instance ID, the correct zone, and a valid SSH public key.
Members
ServiceException
Description
Indicates that the service encountered an error. Follow the message's instructions and try again.