AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
For .NET Core this operation is only available in asynchronous form. Please refer to RevokeGrantAsync.
Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
public virtual RevokeGrantResponse RevokeGrant( RevokeGrantRequest request )
Container for the necessary parameters to execute the RevokeGrant service method.
| Exception | Condition |
|---|---|
| DependencyTimeoutException | The system timed out while trying to fulfill the request. You can retry the request. |
| DryRunOperationException | The request was rejected because the DryRun parameter was specified. |
| InvalidArnException | The request was rejected because a specified ARN, or an ARN in a key policy, is not valid. |
| InvalidGrantIdException | The request was rejected because the specified GrantId is not valid. |
| KMSInternalException | The request was rejected because an internal exception occurred. The request can be retried. |
| KMSInvalidStateException | The request was rejected because the state of the specified resource is not valid for this request. This exceptions means one of the following: The key state of the KMS key is not compatible with the operation. To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide. For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception. |
| NotFoundException | The request was rejected because the specified entity or resource could not be found. |
The following example revokes a grant.
var client = new AmazonKeyManagementServiceClient();
var response = client.RevokeGrant(new RevokeGrantRequest
{
GrantId = "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", // The identifier of the grant to revoke.
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the KMS key associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
});
.NET Framework:
Supported in: 4.5, 4.0, 3.5