Class: Aws::KMS::Types::ListKeyRotationsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::ListKeyRotationsRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-kms/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#include_key_material ⇒ String
Use this optional parameter to control which key materials associated with this key are listed in the response.
-
#key_id ⇒ String
Gets the key rotations for the specified KMS key.
-
#limit ⇒ Integer
Use this parameter to specify the maximum number of items to return.
-
#marker ⇒ String
Use this parameter in a subsequent request after you receive a response with truncated results.
Instance Attribute Details
#include_key_material ⇒ String
Use this optional parameter to control which key materials associated with this key are listed in the response. The default value of this parameter is ‘ROTATIONS_ONLY`. If you omit this parameter, KMS returns information on the key materials created by automatic or on-demand key rotation. When you specify a value of `ALL_KEY_MATERIAL`, KMS adds the first key material and any imported key material pending rotation to the response. This parameter can only be used with KMS keys that support automatic or on-demand key rotation.
4875 4876 4877 4878 4879 4880 4881 4882 |
# File 'lib/aws-sdk-kms/types.rb', line 4875 class ListKeyRotationsRequest < Struct.new( :key_id, :include_key_material, :limit, :marker) SENSITIVE = [] include Aws::Structure end |
#key_id ⇒ String
Gets the key rotations for the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID: ‘1234abcd-12ab-34cd-56ef-1234567890ab`
-
Key ARN: ‘arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
4875 4876 4877 4878 4879 4880 4881 4882 |
# File 'lib/aws-sdk-kms/types.rb', line 4875 class ListKeyRotationsRequest < Struct.new( :key_id, :include_key_material, :limit, :marker) SENSITIVE = [] include Aws::Structure end |
#limit ⇒ Integer
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.
4875 4876 4877 4878 4879 4880 4881 4882 |
# File 'lib/aws-sdk-kms/types.rb', line 4875 class ListKeyRotationsRequest < Struct.new( :key_id, :include_key_material, :limit, :marker) SENSITIVE = [] include Aws::Structure end |
#marker ⇒ String
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.
4875 4876 4877 4878 4879 4880 4881 4882 |
# File 'lib/aws-sdk-kms/types.rb', line 4875 class ListKeyRotationsRequest < Struct.new( :key_id, :include_key_material, :limit, :marker) SENSITIVE = [] include Aws::Structure end |