Skip to main content

DeleteAccessKey

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

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

Permissions​

ActionDescriptionResource
DeleteAccessKeyGrants permission to delete the access key pair that is associated with the specified IAM useruser

Request Parameters​

For information about the parameters that are common to all actions, see Common Parameters.

AccessKeyId

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.

Type: String

Length Constraints: Minimum length of 16. Maximum length of 128.

Pattern: [\w]+

Required: Yes

UserName

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

caution

The parameter is called UserName even though it takes a role name as a value. This is to preserve the ability to use the AWS SDK and AWS CLI.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+=,.@-]+

Required: No

Errors​

LimitExceeded

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

HTTP Status Code: 409

NoSuchEntity

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

HTTP Status Code: 404

InternalError

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

Examples​

Example​

This example illustrates one usage of DeleteAccessKey.

https://<partition>.iam.astran.io/?Action=DeleteAccessKey
&UserName=Bob
&AccessKeyId=AKIAIOSFODNN7EXAMPLE
&Version=2010-05-08
&AUTHPARAMS
<DeleteAccessKeyResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
  <ResponseMetadata>
    <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
  </ResponseMetadata>
</DeleteAccessKeyResponse>

See Also​

For more information about using this API in one of the language-specific AWS SDKs, see the following: