Container for the parameters to the ListGrants operation. Gets a list of all grants for the specified KMS key.
You must specify the KMS key in all requests. You can filter the grant list by grant ID, grantee principal, or grantee service principal.
For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide. For examples of creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI.
When a grant is created with the GranteePrincipal field, the ListGrants
response usually contains the user or role designated as the grantee principal in
the grant. However, if the grantee principal is an Amazon Web Services service, the
GranteePrincipal field contains an Amazon Web Services service
principal, which might correspond to several different grantee principals, such
as an IAM user, IAM role, or Amazon Web Services account.
When a grant is created with the GranteeServicePrincipal field, the ListGrants
response always includes a GranteeServicePrincipal that indicates the grantee
is actually an Amazon Web Services service
principal.
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:ListGrants (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
In this article ▶
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.ListGrantsRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class ListGrantsRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The ListGrantsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListGrantsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
GranteePrincipal | System.String |
Gets and sets the property GranteePrincipal. Returns only grants where the specified principal is the grantee principal for the grant.
You can specify either |
|
|
GranteeServicePrincipal | System.String |
Gets and sets the property GranteeServicePrincipal. Returns only grants where the specified Amazon Web Services service principal is the grantee service principal for the grant. This filter is only usable by callers in a service principal.
You can specify either |
|
|
GrantId | System.String |
Gets and sets the property GrantId. Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant. |
|
|
KeyId | System.String |
Gets and sets the property KeyId. Returns only grants for the specified KMS key. This parameter is required. Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
|
|
Limit | System.Nullable<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 |
Examples
The following example lists grants for the specified KMS key.
To list grants for a KMS key
var client = new AmazonKeyManagementServiceClient();
var response = client.ListGrants(new ListGrantsRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the KMS key whose grants you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
});
List<GrantListEntry> grants = response.Grants; // A list of grants.
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.
The following example lists grants for the specified KMS key that were created with a GranteeServicePrincipal. The response includes the GranteeServicePrincipal, RetiringServicePrincipal, and SourceArn constraint fields.
To list grants for a grantee service principal
var client = new AmazonKeyManagementServiceClient();
var response = client.ListGrants(new ListGrantsRequest
{
GranteeServicePrincipal = "service-name.amazonaws.com", // Returns only grants where the specified AWS service principal is the grantee service principal.
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the KMS key whose grants you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
});
List<GrantListEntry> grants = response.Grants; // A list of grants.
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:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer