Container for the parameters to the ListKeyRotations operation. Returns information about all completed key material rotations for the specified KMS key.
You must specify the KMS key in all requests. You can refine the key rotations list by limiting the number of rotations returned.
For detailed information about automatic and on-demand key rotations, see Rotating KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ListKeyRotations (key 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.ListKeyRotationsRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class ListKeyRotationsRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The ListKeyRotationsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListKeyRotationsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
KeyId | System.String |
Gets and sets the property KeyId. Gets the key rotations for the specified KMS key. Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
|
|
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 returns information about all completed key material rotations for the specified KMS key.
To retrieve information about all completed key material rotations
var client = new AmazonKeyManagementServiceClient();
var response = client.ListKeyRotations(new ListKeyRotationsRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
});
List<RotationsListEntry> rotations = response.Rotations; // A list of key rotations.
bool truncated = response.Truncated; // A flag that indicates whether there are more items in the list. When the value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
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