AmazonKeyManagementServiceClient.GetKeyPolicy Method (string, string)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetKeyPolicyAsync.

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

Syntax

public virtual GetKeyPolicyResponse GetKeyPolicy(
         String keyId,
         String policyName
)

keyId: Type: System.String

Gets the key policy for the specified KMS key. Specify the key ID or key ARN of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

policyName: Type: System.String

Specifies the name of the key policy. If no policy name is specified, the default value is default. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

The response from the GetKeyPolicy service method, as returned by KeyManagementService.

Exception	Condition
DependencyTimeoutException	The system timed out while trying to fulfill the request. You can retry the request.
InvalidArnException	The request was rejected because a specified ARN, or an ARN in a key policy, is 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. This exceptions means one of the following: The key state of the KMS key is not compatible with the operation. To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide. For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.
NotFoundException	The request was rejected because the specified entity or resource could not be found.

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