Module Smaws_Client_KMS.RevokeGrant

val request : Smaws_Lib.Context.t -> revoke_grant_request -> (unit, [> Smaws_Lib.Protocols.AwsJson.error | `DependencyTimeoutException of dependency_timeout_exception | `DryRunOperationException of dry_run_operation_exception | `InvalidArnException of invalid_arn_exception | `InvalidGrantIdException of invalid_grant_id_exception | `KMSInternalException of kms_internal_exception | `KMSInvalidStateException of kms_invalid_state_exception | `NotFoundException of not_found_exception ]) Stdlib.result

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 working with grants in several programming languages, see Programming grants.

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:

  • CreateGrant
  • ListGrants
  • ListRetirableGrants
  • RetireGrant

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