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 a grant. Typically, you retire a grant when you no longer need its permissions. To identify the grant to retire, use a grant token, or both the grant ID and a key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation returns both values.
This operation can be called by the retiring principal for a grant, by the
grantee principal if the grant allows the RetireGrant operation, and
by the Amazon Web Services account in which the grant is created. It can also be called
by principals to whom permission for retiring a grant is delegated. For details, see
Retiring
and revoking grants 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. You can retire a grant on a KMS key in a different Amazon Web Services account.
Required permissions: Permission to retire a grant is determined primarily by the grant. For details, see Retiring and revoking grants in the Key Management Service Developer Guide.
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginRetireGrant and EndRetireGrant.
Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
public abstract Task<RetireGrantResponse> RetireGrantAsync( String grantToken, CancellationToken cancellationToken )
Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency. Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| 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. |
| InvalidGrantTokenException | The request was rejected because the specified grant token 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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5