Skip to content

KMS  >  Operations  >  put_key_policy

put_key_policy

Operation

put_key_policy async 

put_key_policy(input: PutKeyPolicyInput, plugins: list[Plugin] | None = None) -> PutKeyPolicyOutput

Attaches a key policy to the specified KMS key.

For more information about key policies, see Key Policies in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide . For examples of adding a key policy in multiple programming languages, see Use PutKeyPolicy with an Amazon Web Services SDK or CLI in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:PutKeyPolicy (key policy)

Related operations: GetKeyPolicy

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Parameters:

Name Type Description Default
input PutKeyPolicyInput

An instance of PutKeyPolicyInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
PutKeyPolicyOutput

An instance of PutKeyPolicyOutput.

Input

PutKeyPolicyInput dataclass

Bases: _SerdeShape

Dataclass for PutKeyPolicyInput structure.

Attributes

bypass_policy_lockout_safety_check class-attribute instance-attribute 
bypass_policy_lockout_safety_check: bool = ...

Skips ("bypasses") the key policy lockout safety check. The default value is false.

Warning

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

For more information, see Default key policy in the Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

key_id class-attribute instance-attribute 
key_id: str | None = ...

Sets the key policy on 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.

policy class-attribute instance-attribute 
policy: str | None = ...

The key policy to attach to the KMS key.

The key policy must meet the following criteria:

- The key policy must allow the calling principal to make a subsequent
  `PutKeyPolicy` request on the KMS key. This reduces the risk that the
  KMS key becomes unmanageable. For more information, see [Default key
  policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key)
  in the *Key Management Service Developer Guide*. (To omit this
  condition, set `BypassPolicyLockoutSafetyCheck` to true.)

- Each statement in the key policy must contain one or more principals.
  The principals in the key policy must exist and be visible to KMS.
  When you create a new Amazon Web Services principal, you might need to
  enforce a delay before including the new principal in a key policy
  because the new principal might not be immediately visible to KMS. For
  more information, see [Changes that I make are not always immediately
  visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency)
  in the *Amazon Web Services Identity and Access Management User
  Guide*.

Note:
    If either of the required `Resource` or `Action` elements are missing
    from a key policy statement, the policy statement has no effect. When a
    key policy statement is missing one of these elements, the KMS console
    correctly reports an error, but the `PutKeyPolicy` API request succeeds,
    even though the policy statement is ineffective.

    For more information on required key policy elements, see [Elements in a
    key
    policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-overview.html#key-policy-elements)
    in the *Key Management Service Developer Guide*.

A key policy document can include only the following characters:

- Printable ASCII characters from the space character (` `) through
  the end of the ASCII character range.

- Printable characters in the Basic Latin and Latin-1 Supplement
  character set (through `ΓΏ`).

- The tab (`        `), line feed (`

), and carriage return ( `) special characters

Note:
    If the key policy exceeds the length constraint, KMS returns a
    `LimitExceededException`.

For information about key policies, see [Key policies in
KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)
in the *Key Management Service Developer Guide*.For help writing and
formatting a JSON policy document, see the [IAM JSON Policy
Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html)
in the Identity and Access Management User Guide .
policy_name class-attribute instance-attribute 
policy_name: str | None = ...

The name of the key policy. If no policy name is specified, the default value is default. The only valid value is default.

Output

PutKeyPolicyOutput dataclass

Bases: _SerdeShape

Dataclass for PutKeyPolicyOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.