Container for the parameters to the ListRetirableGrants operation. Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal.
You can specify any principal in your Amazon Web Services account. The grants that are returned include grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.
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: You must specify a principal in your Amazon Web Services
account. This operation returns a list of grants where the retiring principal specified
in the ListRetirableGrants request is the same retiring principal on the grant.
This can include grants on KMS keys owned by other Amazon Web Services accounts, but
you do not need kms:ListRetirableGrants permission (or any other additional
permission) in any Amazon Web Services account other than your own.
Required permissions: kms:ListRetirableGrants (IAM policy) in your Amazon Web Services account.
KMS authorizes ListRetirableGrants requests by evaluating the caller account's
kms:ListRetirableGrants permissions. The authorized resource in ListRetirableGrants
calls is the retiring principal specified in the request. KMS does not evaluate the
caller's permissions to verify their access to any KMS keys or grants that might be
returned by the ListRetirableGrants call.
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.ListRetirableGrantsRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class ListRetirableGrantsRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The ListRetirableGrantsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListRetirableGrantsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Limit | System.Int32 |
Gets and sets the property Limit. Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. |
|
|
Marker | System.String |
Gets and sets the property Marker.
Use this parameter in a subsequent request after you receive a response with truncated
results. Set it to the value of |
|
|
RetiringPrincipal | System.String |
Gets and sets the property RetiringPrincipal. The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account. To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide. |
Examples
The following example lists the grants that the specified principal (identity) can retire.
To list grants that the specified principal can retire
var client = new AmazonKeyManagementServiceClient();
var response = client.ListRetirableGrants(new ListRetirableGrantsRequest
{
RetiringPrincipal = "arn:aws:iam::111122223333:role/ExampleRole" // The retiring principal whose grants you want to list. Use the Amazon Resource Name (ARN) of a principal such as an AWS account (root), IAM user, federated user, or assumed role user.
});
List<GrantListEntry> grants = response.Grants; // A list of grants that the specified principal can retire.
bool truncated = response.Truncated; // A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5