UpdateAccessKeyRequest Class | AWS SDK for .NET V3

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

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

public class UpdateAccessKeyRequest : AmazonIdentityManagementServiceRequest
         IAmazonWebServiceRequest

The UpdateAccessKeyRequest type exposes the following members

Constructors

	Name	Description
	UpdateAccessKeyRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	UpdateAccessKeyRequest(string, StatusType)	Instantiates UpdateAccessKeyRequest with the parameterized properties

Properties

Name Type Description

Name	Type	Description
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 (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
Status	Amazon.IdentityManagement.StatusType	Gets and sets the property Status. The status you want to assign to the secret access key. `Active` means that the key can be used for programmatic calls to Amazon Web Services, while `Inactive` means that the key cannot be used.
UserName	System.String	Gets and sets the property 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: _+=,.@-

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 (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

Status

Amazon.IdentityManagement.StatusType

Gets and sets the property Status.

The status you want to assign to the secret access key. Active means that the key can be used for programmatic calls to Amazon Web Services, while Inactive means that the key cannot be used.

UserName

System.String

Gets and sets the property 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: _+=,.@-

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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

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