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

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

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 ListGrantsRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#key_idString

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Returns:

  • (String)


1534
1535
1536
1537
1538
1539
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1534

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

Returns:

  • (Integer)


1534
1535
1536
1537
1538
1539
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1534

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


1534
1535
1536
1537
1538
1539
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1534

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