Class: Aws::KMS::Types::ListGrantsRequest

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

Overview

Note:

When making an API call, you may pass ListGrantsRequest data as a hash:

{
  limit: 1,
  marker: "MarkerType",
  key_id: "KeyIdType", # required
}

See Also:

Instance Attribute Summary collapse

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. To specify a CMK in a different AWS account, you must use the key ARN.

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) 


1642
1643
1644
1645
1646
1647
 
# File 'lib/aws-sdk-kms/types.rb', line 1642

class ListGrantsRequest < Struct.new(
  :limit,
  :marker,
  :key_id)
  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 100, inclusive. If you do not include a value, it defaults to 50.

Returns:

  • (Integer) 


1642
1643
1644
1645
1646
1647
 
# File 'lib/aws-sdk-kms/types.rb', line 1642

class ListGrantsRequest < Struct.new(
  :limit,
  :marker,
  :key_id)
  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.

Returns:

  • (String) 


1642
1643
1644
1645
1646
1647
 
# File 'lib/aws-sdk-kms/types.rb', line 1642

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