ListAccessKeysRequest Class | AWS SDK for .NET V3

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IdentityManagement.AmazonIdentityManagementServiceRequest
      Amazon.IdentityManagement.Model.ListAccessKeysRequest

Namespace: Amazon.IdentityManagement.Model
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z

Syntax

public class ListAccessKeysRequest : AmazonIdentityManagementServiceRequest
         IAmazonWebServiceRequest

The ListAccessKeysRequest type exposes the following members

Constructors

	Name	Description
	ListAccessKeysRequest()	Empty constructor used to set properties independently even when a simple constructor is available

Properties

Name Type Description

Name	Type	Description
Marker	System.String	Gets and sets the property 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	System.Int32	Gets and sets the property 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.
UserName	System.String	Gets and sets the property 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

System.String

Gets and sets the property 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

System.Int32

Gets and sets the property 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.

UserName

System.String

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

Examples

The following command lists the access keys IDs for the IAM user named Alice.

To list the access key IDs for an IAM user


var client = new AmazonIdentityManagementServiceClient();
var response = client.ListAccessKeys(new ListAccessKeysRequest 
{
    UserName = "Alice"
});

List<AccessKeyMetadata> accessKeyMetadata = response.AccessKeyMetadata;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5