You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::KMS::Types::ListKeyPoliciesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

Note:

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

Instance Attribute Details

#key_idString

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.

Returns:

  • (String)


1697
1698
1699
1700
1701
1702
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1697

class ListKeyPoliciesRequest < Struct.new(
  :key_id,
  :limit,
  :marker)
  include Aws::Structure
end

#limitInteger

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.

Returns:

  • (Integer)


1697
1698
1699
1700
1701
1702
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1697

class ListKeyPoliciesRequest < Struct.new(
  :key_id,
  :limit,
  :marker)
  include Aws::Structure
end

#markerString

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.

Returns:

  • (String)


1697
1698
1699
1700
1701
1702
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1697

class ListKeyPoliciesRequest < Struct.new(
  :key_id,
  :limit,
  :marker)
  include Aws::Structure
end