Container for the parameters to the ListKeys operation. Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ListKeys (IAM policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.ListKeysRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class ListKeysRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The ListKeysRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListKeysRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
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, 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. |
|
|
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 |
Examples
The following example lists KMS keys.
To list KMS keys
var client = new AmazonKeyManagementServiceClient();
var response = client.ListKeys(new ListKeysRequest
{
});
List<KeyListEntry> keys = response.Keys; // A list of KMS keys, 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:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5