AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root 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.

Note:

For PCL and Unity 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

C#
public abstract UpdateAccessKeyResponse UpdateAccessKey(
         UpdateAccessKeyRequest request
)
Parameters
request
Type: Amazon.IdentityManagement.Model.UpdateAccessKeyRequest

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

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

Exceptions

ExceptionCondition
LimitExceededException The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
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 response = client.UpdateAccessKey(new UpdateAccessKeyRequest 
{
    AccessKeyId = "AKIAIOSFODNN7EXAMPLE",
    Status = "Inactive",
    UserName = "Bob"
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also