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.

Container for the parameters to the UpdateAccessKey operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IdentityManagement.AmazonIdentityManagementServiceRequest
      Amazon.IdentityManagement.Model.UpdateAccessKeyRequest

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

Syntax

C#
public class UpdateAccessKeyRequest : AmazonIdentityManagementServiceRequest
         IAmazonWebServiceRequest

The UpdateAccessKeyRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateAccessKeyRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method UpdateAccessKeyRequest(string, StatusType)

Instantiates UpdateAccessKeyRequest with the parameterized properties

Properties

NameTypeDescription
Public Property AccessKeyId System.String

Gets and sets the property AccessKeyId.

The access key ID of the secret access key you want to update.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

Public Property Status Amazon.IdentityManagement.StatusType

Gets and sets the property Status.

The status you want to assign to the secret access key. Active means the key can be used for API calls to AWS, while Inactive means the key cannot be used.

Public Property UserName System.String

Gets and sets the property UserName.

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

This parameter allows (per 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: =,.@-

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 Standard:
Supported in: 1.3

.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