UpdateHostKey - AWS Transfer Family

UpdateHostKey

Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.

Request Syntax

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

An updated description for the host key.

Type: String

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

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

Required: Yes

HostKeyId

The identifier of the host key that you are updating.

Type: String

Length Constraints: Fixed length of 25.

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

Required: Yes

ServerId

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

Type: String

Length Constraints: Fixed length of 19.

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

Required: Yes

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 updated host key.

Type: String

Length Constraints: Fixed length of 25.

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

ServerId

Returns the server identifier for the server that contains the updated host 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

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: