AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetKeyPolicy operation. Retrieves a policy attached to the specified key.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
      Amazon.KeyManagementService.Model.GetKeyPolicyRequest

Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z

Syntax

C#
public class GetKeyPolicyRequest : AmazonKeyManagementServiceRequest
         IAmazonWebServiceRequest

The GetKeyPolicyRequest type exposes the following members

Constructors

NameDescription
Public Method GetKeyPolicyRequest()

Properties

NameTypeDescription
Public Property KeyId System.String

Gets and sets the property KeyId.

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Public Property PolicyName System.String

Gets and sets the property PolicyName.

String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.

Examples

The following example retrieves the key policy for the specified customer master key (CMK).

To retrieve a key policy


var response = client.GetKeyPolicy(new GetKeyPolicyRequest 
{
    KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the CMK whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
    PolicyName = "default" // The name of the key policy to retrieve.
});

string policy = response.Policy; // The key policy document.

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms