DeleteSshPublicKey - AWS Transfer Family

DeleteSshPublicKey

Deletes a user's Secure Shell (SSH) public key.

Request Syntax

{ "ServerId": "string", "SshPublicKeyId": "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 a file transfer protocol-enabled server instance that has the user assigned to it.

Type: String

Length Constraints: Fixed length of 19.

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

Required: Yes

SshPublicKeyId

A unique identifier used to reference your user's specific SSH key.

Type: String

Length Constraints: Fixed length of 21.

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

Required: Yes

UserName

A unique string that identifies a user whose public key is being deleted.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 100.

Pattern: ^[\w][\w@.-]{2,99}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

HTTP Status Code: 400

Examples

Example

The following example deletes a user's SSH public key.

Sample Request

{ "ServerId": "s-01234567890abcdef", "SshPublicKeyId": "MyPublicKey", "UserName": "my_user" }

See Also

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