AWS SDK Version 2 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.

.NET Framework 3.5
 
Attaches a policy to the specified key.

Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public virtual PutKeyPolicyResponse PutKeyPolicy(
         String keyId,
         String policy,
         String policyName
)

Parameters

keyId
Type: System.String

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-123456789012Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

policy
Type: System.String

The policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes).

policyName
Type: System.String

Name of the policy to be attached. Currently, the only supported name is "default".

Return Value
Type: Amazon.KeyManagementService.Model.PutKeyPolicyResponse
The response from the PutKeyPolicy service method, as returned by KeyManagementService.

Exceptions

ExceptionCondition
DependencyTimeoutException The system timed out while trying to fulfill the request. The request can be retried.
InvalidArnException The request was rejected because a specified ARN was not valid.
InvalidArnException The request was rejected because a specified ARN was not valid.
KMSInternalException The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException The request was rejected because the state of the specified resource is not valid for this request. For more information about how key state affects the use of a customer master key (CMK), go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
LimitExceededException The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
MalformedPolicyDocumentException The request was rejected because the specified policy is not syntactically or semantically correct.
NotFoundException The request was rejected because the specified entity or resource could not be found.
UnsupportedOperationException The request was rejected because a specified parameter is not supported.

Version Information

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