Container for the parameters to the RetireGrant operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.RetireGrantRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class RetireGrantRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The RetireGrantRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
RetireGrantRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DryRun | System.Boolean |
Gets and sets the property DryRun.
Checks if your request will succeed. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide. |
|
|
GrantId | System.String |
Gets and sets the property GrantId. Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.
|
|
|
GrantToken | System.String |
Gets and sets the property GrantToken. 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. |
|
|
KeyId | System.String |
Gets and sets the property KeyId. The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.
For example: |
Examples
The following example retires a grant.
To retire a grant
var client = new AmazonKeyManagementServiceClient();
var response = client.RetireGrant(new RetireGrantRequest
{
GrantId = "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", // The identifier of the grant to retire.
KeyId = "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab" // The Amazon Resource Name (ARN) of the KMS key associated with the grant.
});
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5