kms_list_grants: Gets a list of all grants for the specified KMS key

View source: R/kms_operations.R

kms_list_grantsR Documentation

Gets a list of all grants for the specified KMS key


Gets a list of all grants for the specified KMS key.

See for full documentation.


  Limit = NULL,
  Marker = NULL,
  GrantId = NULL,
  GranteePrincipal = NULL



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 100, inclusive. If you do not include a value, it defaults to 50.


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.


[required] Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use list_keys or describe_key.


Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.


Returns only grants where the specified principal is the grantee principal for the grant. documentation built on May 29, 2024, 10:51 a.m.