kms_revoke_grant: Revokes the specified grant for the specified customer master...

Description Usage Arguments Details Request syntax Examples

View source: R/kms_operations.R

Description

Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.

Usage

1
kms_revoke_grant(KeyId, GrantId)

Arguments

KeyId

[required] A unique identifier for the customer master key associated with the grant.

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.

GrantId

[required] Identifier of the grant to be revoked.

Details

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Request syntax

1
2
3
4
svc$revoke_grant(
  KeyId = "string",
  GrantId = "string"
)

Examples

1
2
3
4
5
# The following example revokes a grant.
svc$revoke_grant(
  GrantId = "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60",
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.