import-ssh-public-key¶
Description¶
Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId .
The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
import-ssh-public-key
--server-id <value>
--ssh-public-key-body <value>
--user-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--server-id (string)
A system-assigned unique identifier for a server.
--ssh-public-key-body (string)
The public key portion of an SSH key pair.
--user-name (string)
The name of the user account that is assigned to one or more servers.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
ServerId -> (string)
A system-assigned unique identifier for a server.
SshPublicKeyId -> (string)
The name given to a public key by the system that was imported.
UserName -> (string)
A user name assigned to the
ServerIDvalue that you specified.