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:
Source code in docs_src/capo_transfer/_services/transfer.py
| def delete_ssh_public_key(
self,
server_id: "capo_transfer.types.server_id.ServerId",
ssh_public_key_id: "capo_transfer.types.ssh_public_key_id.SshPublicKeyId",
user_name: "capo_transfer.types.user_name.UserName",
*,
config_overrides: Optional[TransferClientConfig] = None,
) -> None:
"""<p>Deletes a user's Secure Shell (SSH) public key.</p>
Args:
server_id: <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.</p>
ssh_public_key_id: <p>A unique identifier used to reference your user's specific SSH key.</p>
user_name: <p>A unique string that identifies a user whose public key is being deleted.</p>
Raises:
capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
capo_transfer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_transfer.types.delete_ssh_public_key_request.DeleteSshPublicKeyRequest]",
) -> OperationResponse[None]:
import capo_transfer._operations.transfer_service.delete_ssh_public_key
output, http_response = (
capo_transfer._operations.transfer_service.delete_ssh_public_key.delete_ssh_public_key(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteSshPublicKey")
)
input_: capo_transfer.types.delete_ssh_public_key_request.DeleteSshPublicKeyRequest = {
"server_id": server_id,
"ssh_public_key_id": ssh_public_key_id,
"user_name": user_name,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|