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 .

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. For details, see Eventual consistency in the Key Management Service Developer Guide .

For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI.

Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.

Required permissions: kms:RevokeGrant (key policy).

Related operations:

• create_grant
• list_grants
• list_retirable_grants
• retire_grant

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Usage¶

kms_revoke_grant(KeyId, GrantId, DryRun)

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 permissions in the Key Management Service Developer Guide.

Value¶

An empty list.

Request syntax¶

svc$revoke_grant(
  KeyId = "string",
  GrantId = "string",
  DryRun = TRUE|FALSE
)

Examples¶

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