Class: Aws::KMS::Types::ListKeyPoliciesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::ListKeyPoliciesRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-kms/types.rb
Overview
When making an API call, you may pass ListKeyPoliciesRequest data as a hash:
{
key_id: "KeyIdType", # required
limit: 1,
marker: "MarkerType",
}
Instance Attribute Summary collapse
-
#key_id ⇒ String
A unique identifier for the customer master key (CMK).
-
#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
#key_id ⇒ String
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
2102 2103 2104 2105 2106 2107 |
# File 'lib/aws-sdk-kms/types.rb', line 2102 class ListKeyPoliciesRequest < Struct.new( :key_id, :limit, :marker) include Aws::Structure end |
#limit ⇒ Integer
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.
Currently only 1 policy can be attached to a key.
2102 2103 2104 2105 2106 2107 |
# File 'lib/aws-sdk-kms/types.rb', line 2102 class ListKeyPoliciesRequest < Struct.new( :key_id, :limit, :marker) 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.
2102 2103 2104 2105 2106 2107 |
# File 'lib/aws-sdk-kms/types.rb', line 2102 class ListKeyPoliciesRequest < Struct.new( :key_id, :limit, :marker) include Aws::Structure end |