kms_revoke_grant: Deletes the specified grant

View source: R/kms_operations.R

kms_revoke_grantR Documentation

Deletes the specified grant

Description

Deletes the specified grant. You revoke a grant to terminate the permissions that the grant allows. For more information, see Retiring and revoking grants in the Key Management Service Developer Guide .

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

Usage

kms_revoke_grant(KeyId, GrantId, DryRun = NULL)

Arguments

KeyId

[required] A unique identifier for the KMS key associated with the grant. To get the key ID and key ARN for a KMS key, use list_keys or describe_key.

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.

GrantId

[required] Identifies the grant to revoke. To get the grant ID, use create_grant, list_grants, or list_retirable_grants.

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.


paws.security.identity documentation built on Sept. 12, 2024, 6:30 a.m.