Container for the parameters to the GetKeyPolicy operation. Gets a key policy attached to the specified KMS key.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetKeyPolicy (key policy)
Related operations: PutKeyPolicy
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.GetKeyPolicyRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class GetKeyPolicyRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The GetKeyPolicyRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetKeyPolicyRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
KeyId | System.String |
Gets and sets the property KeyId. Gets the key policy 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. |
|
|
PolicyName | System.String |
Gets and sets the property PolicyName.
Specifies the name of the key policy. If no policy name is specified, the default
value is |
Examples
The following example retrieves the key policy for the specified KMS key.
To retrieve a key policy
var client = new AmazonKeyManagementServiceClient();
var response = client.GetKeyPolicy(new GetKeyPolicyRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
PolicyName = "default" // The name of the key policy to retrieve.
});
string policy = response.Policy; // The key policy document.
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