AWS Transfer for SFTP
User Guide

ImportSshPublicKey

Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

Request Syntax

{ "ServerId": "string", "SshPublicKeyBody": "string", "UserName": "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.

ServerId

A system-assigned unique identifier for an SFTP server.

Type: String

Pattern: ^s-([0-9a-f]{17})$

Required: Yes

SshPublicKeyBody

The public key portion of an SSH key pair.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^ssh-rsa\s+[A-Za-z0-9+/]+[=]{0,3}(\s+.+)?\s*$

Required: Yes

UserName

The name of the user account that is assigned to one or more servers.

Type: String

Pattern: ^[a-z0-9]{3,32}$

Required: Yes

Response Syntax

{ "ServerId": "string", "SshPublicKeyId": "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.

ServerId

A system-assigned unique identifier for an SFTP server.

Type: String

Pattern: ^s-([0-9a-f]{17})$

SshPublicKeyId

This identifier is the name given to a public key by the system that was imported.

Type: String

Pattern: ^key-[0-9a-f]{17}$

UserName

A user name assigned to the ServerID value that you specified.

Type: String

Pattern: ^[a-z0-9]{3,32}$

Errors

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

InternalServiceError

This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

HTTP Status Code: 500

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400

ResourceExistsException

The requested resource does not exist.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWS Transfer for SFTP service is not available.

HTTP Status Code: 500

Examples

Example

The following example returns the properties assigned to a Secure File Transfer Protocol (SFTP) server.

Sample Request

{ "ServerId": "s-01234567890abcdef" "SshPublicKeyBody": "AAAAB3NzaC1yc2EAAAADAQABAAABAQCOtfCAis3aHfM6yc8KWAlMQxVDBHyccCde9MdLf4DQNXn8HjAHf+Bc1vGGCAREFUL1NO2PEEKING3ALLOWEDfIf+JBecywfO35Cm6IKIV0JF2YOPXvOuQRs80hQaBUvQL9xw6VEb4xzbit2QB6", "UserName": "SFTP_USER" }

Example

Sample Response

{ "User": { "ServerId": "s-01234567890abcdef", "SshPublicKeyId": "MySSHPublicKey" "UserName": "SFTP_USER", } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: