iam_update_access_key: Changes the status of the specified access key from Active to...

Description Usage Arguments Details Request syntax Examples

View source: R/iam_operations.R

Description

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.

Usage

1
iam_update_access_key(UserName, AccessKeyId, Status)

Arguments

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: \_+=,[email protected]

AccessKeyId

[required] 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

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

Details

If the UserName is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. 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 syntax

1
2
3
4
5
svc$update_access_key(
  UserName = "string",
  AccessKeyId = "string",
  Status = "Active"|"Inactive"
)

Examples

1
2
3
4
5
6
7
# The following command deactivates the specified access key (access key
# ID and secret access key) for the IAM user named Bob.
svc$update_access_key(
  AccessKeyId = "AKIAIOSFODNN7EXAMPLE",
  Status = "Inactive",
  UserName = "Bob"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.