Container for the parameters to the ListKeyPolicies operation.
Gets the names of the key policies that are attached to a KMS key. This operation
is designed to get policy names that you can use in a GetKeyPolicy operation.
However, the only valid policy name is default.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ListKeyPolicies (key policy)
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.ListKeyPoliciesRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class ListKeyPoliciesRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The ListKeyPoliciesRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListKeyPoliciesRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
KeyId | System.String |
Gets and sets the property KeyId. Gets the names of key policies for the specified KMS key. Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
|
|
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 1000, inclusive. If you do not include a value, it defaults to 100. Only one policy can be attached to a key. |
|
|
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 key policies for the specified KMS key.
To list key policies for a KMS key
var client = new AmazonKeyManagementServiceClient();
var response = client.ListKeyPolicies(new ListKeyPoliciesRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the KMS key whose key policies you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
});
List<string> policyNames = response.PolicyNames; // A list of key policy names.
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