IAM / Client / update_ssh_public_key

update_ssh_public_key#

IAM.Client.update_ssh_public_key(**kwargs)#

Sets the status of an IAM user’s SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user’s SSH public key as part of a key rotation work flow.

The SSH public key affected 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.update_ssh_public_key(
    UserName='string',
    SSHPublicKeyId='string',
    Status='Active'|'Inactive'
)
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.

  • Status (string) –

    [REQUIRED]

    The status to assign to the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

Returns:

None

Exceptions

  • IAM.Client.exceptions.NoSuchEntityException