delete_ssh_public_key
async
¶
delete_ssh_public_key(
server_id: ServerId,
ssh_public_key_id: SshPublicKeyId,
user_name: UserName,
*,
config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> None
Deletes a user's Secure Shell (SSH) public key.
Parameters:
-
server_id(ServerId) –A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.
-
ssh_public_key_id(SshPublicKeyId) –A unique identifier used to reference your user's specific SSH key.
-
user_name(UserName) –A unique string that identifies a user whose public key is being deleted.
Raises:
-
InternalServiceError–This exception is thrown when an error occurs in the Transfer Family service.
-
InvalidRequestException–This exception is thrown when the client submits a malformed request.
-
ResourceNotFoundException–This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
-
ServiceUnavailableException–The request has failed because the Amazon Web ServicesTransfer Family service is not available.
-
ThrottlingException–The request was denied due to request throttling.
-
UnknownServiceError–The service returned an error code this client does not model.