IAM / Client / delete_access_key

delete_access_key#

IAM.Client.delete_access_key(**kwargs)#

Deletes the access key pair associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

See also: AWS API Documentation

Request Syntax

response = client.delete_access_key(
    UserName='string',
    AccessKeyId='string'
)
Parameters:

  • UserName (string) –

    The name of the user whose access key pair you want to delete.

    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: _+=,.@-

  • AccessKeyId (string) –

    [REQUIRED]

    The access key ID for the access key ID and secret access key you want to delete.

    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

  • IAM.Client.exceptions.NoSuchEntityException

  • IAM.Client.exceptions.LimitExceededException

  • IAM.Client.exceptions.ServiceFailureException

Examples

The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.

response = client.delete_access_key(
    AccessKeyId='AKIDPMS9RO4H3FEXAMPLE',
    UserName='Bob',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}