kms_retire_grant: Deletes a grant

Description

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To identify the grant to retire, use a grant token, or both the grant ID and a key identifier (key ID or key ARN) of the KMS key. The create_grant operation returns both values.

See https://www.paws-r-sdk.com/docs/kms_retire_grant/ for full documentation.

Usage

kms_retire_grant(
  GrantToken = NULL,
  KeyId = NULL,
  GrantId = NULL,
  DryRun = NULL
)

Arguments

GrantToken

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the create_grant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

KeyId

The key ARN KMS key associated with the grant. To find the key ARN, use the list_keys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

GrantId

Identifies the grant to retire. To get the grant ID, use create_grant, list_grants, or list_retirable_grants.

Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

DryRun

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.