List Access Keys

iam_list_access_keys

R Documentation

Returns information about the access key IDs associated with the specified IAM user

Description

Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

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. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.

To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.

Usage

iam_list_access_keys(UserName, Marker, MaxItems)

Arguments

UserName	The name of the user. 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: _+=,.@-
Marker	Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
MaxItems	Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Value

A list with the following syntax:

list(
  AccessKeyMetadata = list(
    list(
      UserName = "string",
      AccessKeyId = "string",
      Status = "Active"|"Inactive",
      CreateDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  IsTruncated = TRUE|FALSE,
  Marker = "string"
)

Request syntax

svc$list_access_keys(
  UserName = "string",
  Marker = "string",
  MaxItems = 123
)

Examples

## Not run: 
# The following command lists the access keys IDs for the IAM user named
# Alice.
svc$list_access_keys(
  UserName = "Alice"
)

## End(Not run)