IAM / Client / delete_ssh_public_key

delete_ssh_public_key#

IAM.Client.delete_ssh_public_key(**kwargs)#

Deletes the specified SSH public key.

The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

See also: AWS API Documentation

Request Syntax

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

  • UserName (string) –

    [REQUIRED]

    The name of the IAM user associated with the SSH public key.

    This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

  • SSHPublicKeyId (string) –

    [REQUIRED]

    The unique identifier for the SSH public key.

    This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

Returns:

None

Exceptions