kms_update_key_description

Updates the description of a KMS key. To see the description of a KMS key, use <code>describe_key</code>.
See <a href="https://www.paws-r-sdk.com/docs/kms_update_key_description/">https://www.paws-r-sdk.com/docs/kms_update_key_description/</a> for full documentation.

internal

Interface to 'Amazon Web Services' security, identity, and
compliance services, including the 'Identity & Access Management'
('IAM') service for managing access to services and resources, and
more <https://aws.amazon.com/>.

Dyfan Jones

paws.security.identity

'Amazon Web Services' Security, Identity, & Compliance Services

David Kretch

Adam Banker

Amazon.com, Inc. 

kms_update_key_description function

<dl><dt>KeyId</dt>
<dd>[required] Updates the description of the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:<ul>
<li>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></li>
<li>Key ARN:
<code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></li>
</ul></dd>To get the key ID and key ARN for a KMS key, use
<code>list_keys</code> or <code>describe_key</code>.
<dt>Description</dt>
<dd>[required] New description for the KMS key.
Do not include confidential or sensitive information in this field. This
field may be displayed in plaintext in CloudTrail logs and other output.</dd></dl>

Arguments

Updates the description of a KMS key. To see the description of a KMS key, use <code>describe_key</code>.
See <a href='https://www.paws-r-sdk.com/docs/kms_update_key_description/'>https://www.paws-r-sdk.com/docs/kms_update_key_description/</a> for full documentation.

Updates the description of a KMS key — kms_update_key_description

<dl>

<dt>KeyId</dt>
<dd>[required] Updates the description of the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:<ul>
<li>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></li>
<li>Key ARN:
<code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></li>
</ul>

To get the key ID and key ARN for a KMS key, use
<code>list_keys</code> or <code>describe_key</code>.</dd>


<dt>Description</dt>
<dd>[required] New description for the KMS key.
Do not include confidential or sensitive information in this field. This
field may be displayed in plaintext in CloudTrail logs and other output.</dd>

</dl>

kms_update_key_description: Updates the description of a KMS key

Description

Usage

Arguments