ImportHostKey - AWS Transfer Family

ImportHostKey

Adds a host key to the server that's specified by the ServerId parameter.

Request Syntax

{ "Description": "string", "HostKeyBody": "string", "ServerId": "string", "Tags": [ { "Key": "string", "Value": "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.

Description

The text description that identifies this host key.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Pattern: ^[\p{Print}]*$

Required: No

HostKeyBody

The public key portion of an SSH key pair.

AWS Transfer Family accepts RSA, ECDSA, and ED25519 keys.

Type: String

Length Constraints: Maximum length of 4096.

Required: Yes

ServerId

The identifier of the server that contains the host key that you are importing.

Type: String

Length Constraints: Fixed length of 19.

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

Required: Yes

Tags

Key-value pairs that can be used to group and search for host keys.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax

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

HostKeyId

Returns the host key identifier for the imported key.

Type: String

Length Constraints: Fixed length of 25.

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

ServerId

Returns the server identifier that contains the imported key.

Type: String

Length Constraints: Fixed length of 19.

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

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 AWSTransfer Family 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 AWSTransfer Family service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWSTransfer Family service is not available.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

See Also

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