Transfer / Client / delete_ssh_public_key

delete_ssh_public_key#

Transfer.Client.delete_ssh_public_key(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.delete_ssh_public_key(
    ServerId='string',
    SshPublicKeyId='string',
    UserName='string'
)
Parameters:

  • ServerId (string) –

    [REQUIRED]

    A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.

  • SshPublicKeyId (string) –

    [REQUIRED]

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

  • UserName (string) –

    [REQUIRED]

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

Returns:

None

Exceptions

  • Transfer.Client.exceptions.ServiceUnavailableException

  • Transfer.Client.exceptions.InternalServiceError

  • Transfer.Client.exceptions.InvalidRequestException

  • Transfer.Client.exceptions.ResourceNotFoundException

  • Transfer.Client.exceptions.ThrottlingException