iam_list_access_keys: Returns information about the access key IDs associated with...

Description Usage Arguments Details Request syntax Examples

View source: R/iam_operations.R

Description

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

Usage

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

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.

Details

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 field 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.

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

Request syntax

1
2
3
4
5
svc$list_access_keys(
  UserName = "string",
  Marker = "string",
  MaxItems = 123
)

Examples

1
2
3
4
5
# The following command lists the access keys IDs for the IAM user named
# Alice.
svc$list_access_keys(
  UserName = "Alice"
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.