IAM / Client / update_access_key

update_access_key#

IAM.Client.update_access_key(**kwargs)#

Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user’s key as part of a key rotation workflow.

If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. 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.

For information about rotating keys, see Managing keys and certificates in the IAM User Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_access_key(
    UserName='string',
    AccessKeyId='string',
    Status='Active'|'Inactive'
)
Parameters:

  • UserName (string) –

    The name of the user whose key you want to update.

    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 of the secret access key you want to update.

    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 you want to assign to the secret access key. Active means that the key can be used for programmatic calls to Amazon Web Services, while Inactive means that the key cannot be used.

Returns:

None

Exceptions

  • IAM.Client.exceptions.NoSuchEntityException

  • IAM.Client.exceptions.LimitExceededException

  • IAM.Client.exceptions.ServiceFailureException

Examples

The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.

response = client.update_access_key(
    AccessKeyId='AKIAIOSFODNN7EXAMPLE',
    Status='Inactive',
    UserName='Bob',
)

print(response)

Expected Output:

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