AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListKeys operation. Lists the customer master keys.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
      Amazon.KeyManagementService.Model.ListKeysRequest

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

Syntax

C#
public class ListKeysRequest : AmazonKeyManagementServiceRequest
         IAmazonWebServiceRequest

The ListKeysRequest type exposes the following members

Constructors

NameDescription
Public Method ListKeysRequest()

Properties

NameTypeDescription
Public Property Limit System.Int32

Gets and sets the property Limit.

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

Public Property Marker System.String

Gets and sets the property Marker.

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Examples

The following example lists CMKs.

To list customer master keys (CMKs)


var response = client.ListKeys(new ListKeysRequest 
{
});

List keys = response.Keys; // A list of CMKs, including the key ID and Amazon Resource Name (ARN) of each one.
bool truncated = response.Truncated; // A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms