Skip to main content

ListAccessKeys

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 role 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 role name is determined implicitly based on the AWS access key ID used to sign the request. If a long-term key is assigned to the role, then UserName is not required.

caution

The parameter is called UserName even though it takes a role name as a value. This is to preserve the ability to use the AWS SDK and AWS CLI.

This operation works for access keys under the AWS account. If the AWS account has no associated roles, the root account returns it's own access key IDs by running this command.

note

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

Permissions​

ActionDescriptionResource
ListAccessKeysGrants permission to list information about the access key IDs that are associated with the specified IAM useruser

Request Parameters​

For information about the parameters that are common to all actions, see Common Parameters.

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.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\u0020-\u00FF]+

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

UserName

The name of the role.

caution

The parameter is called UserName even though it takes a role name as a value. This is to preserve the ability to use the AWS SDK and AWS CLI.

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: _+=,.@-

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+=,.@-]+

Required: No

Response Elements​

The following elements are returned by the service.

AccessKeyMetadata.member.N

A list of objects containing metadata about the access keys.

Type: Array of AccessKeyMetadata objects

IsTruncated

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Markerrequest parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

Type: Boolean

Marker

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Type: String

Errors​

NoSuchEntity

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

HTTP Status Code: 404

InternalError

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

Examples​

Example​

This example illustrates one usage of ListAccessKeys.

https://<partition>.iam.astran.io/?Action=ListAccessKeys
&UserName=Bob
&Version=2010-05-08
&AUTHPARAMS
<ListAccessKeysResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
  <ListAccessKeysResult>
    <UserName>Bob</UserName>
    <AccessKeyMetadata>
       <member>
          <UserName>Bob</UserName>
          <AccessKeyId>AKIA1234567890EXAMPLE</AccessKeyId>
          <Status>Active</Status> 
       <CreateDate>2016-12-03T18:53:41Z</CreateDate>
       </member>
       <member>
          <UserName>Susan</UserName>
          <AccessKeyId>AKIA2345678901EXAMPLE</AccessKeyId>
          <Status>Inactive</Status>
       <CreateDate>2017-03-25T20:38:14Z</CreateDate>
       </member>
    </AccessKeyMetadata>
    <IsTruncated>false</IsTruncated>
  </ListAccessKeysResult>
  <ResponseMetadata>
    <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
  </ResponseMetadata>
</ListAccessKeysResponse>

See Also​

For more information about using this API in one of the language-specific AWS SDKs, see the following: