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 AWS 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 AWS account. Consequently, you can use this operation to manage AWS account root user
credentials even if the AWS account has no associated users.
For information about rotating keys, see Managing keys and certificates in the IAM User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AccessKeyId
-
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. Type: String
Length Constraints: Minimum length of 16. Maximum length of 128.
Pattern:
[\w]+Required: Yes
- Status
-
The status you want to assign to the secret access key.
Activemeans that the key can be used for programmatic calls to AWS, whileInactivemeans that the key cannot be used.Type: String
Valid Values:
Active | InactiveRequired: Yes
- UserName
-
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: _+=,.@- Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+Required: No
Errors
For information about the errors that are common to all actions, see Common 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
- ServiceFailure
-
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 UpdateAccessKey.
Sample Request
https://iam.amazonaws.com/?Action=UpdateAccessKey
&UserName=Bob
&AccessKeyId=AKIAIOSFODNN7EXAMPLE
&Status=Inactive
&Version=2010-05-08
&AUTHPARAMSSample Response
<UpdateAccessKeyResponse>
<ResponseMetadata>
<RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
</ResponseMetadata>
</UpdateAccessKeyResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
