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.

This is the response object from the GetKeyPolicy operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.KeyManagementService.Model.GetKeyPolicyResponse

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

Syntax

C#
public class GetKeyPolicyResponse : AmazonWebServiceResponse

The GetKeyPolicyResponse type exposes the following members

Constructors

NameDescription
Public Method GetKeyPolicyResponse()

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Policy System.String

Gets and sets the property Policy.

A key policy document in JSON format.

Public Property PolicyName System.String

Gets and sets the property PolicyName.

The name of the key policy. The only valid value is default.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.

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