AmazonIdentityManagementServiceClient.UpdateAccessKey Method (UpdateAccessKeyRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateAccessKeyAsync.

Namespace: Amazon.IdentityManagement
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z

Syntax

public virtual UpdateAccessKeyResponse UpdateAccessKey(
         UpdateAccessKeyRequest request
)

Parameters

request: Type: Amazon.IdentityManagement.Model.UpdateAccessKeyRequest

Container for the necessary parameters to execute the UpdateAccessKey service method.

Return Value

Type: UpdateAccessKeyResponse

The response from the UpdateAccessKey service method, as returned by IdentityManagementService.

Exceptions

Exception	Condition
LimitExceededException	The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
NoSuchEntityException	The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
ServiceFailureException	The request processing has failed because of an unknown error, exception or failure.

Examples

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

To activate or deactivate an access key for an IAM user


var client = new AmazonIdentityManagementServiceClient();
var response = client.UpdateAccessKey(new UpdateAccessKeyRequest 
{
    AccessKeyId = "AKIAIOSFODNN7EXAMPLE",
    Status = "Inactive",
    UserName = "Bob"
});

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonIdentityManagementServiceClient.UpdateAccessKey (UpdateAccessKeyRequest)

Method