aws_sdk_kms/client/
update_key_description.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateKeyDescription`](crate::operation::update_key_description::builders::UpdateKeyDescriptionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`key_id(impl Into<String>)`](crate::operation::update_key_description::builders::UpdateKeyDescriptionFluentBuilder::key_id) / [`set_key_id(Option<String>)`](crate::operation::update_key_description::builders::UpdateKeyDescriptionFluentBuilder::set_key_id):<br>required: **true**<br><p>Updates the description of the specified KMS key.</p> <p>Specify the key ID or key ARN of the KMS key.</p> <p>For example:</p> <ul>  <li>   <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>  <li>   <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li> </ul> <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_key_description::builders::UpdateKeyDescriptionFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_key_description::builders::UpdateKeyDescriptionFluentBuilder::set_description):<br>required: **true**<br><p>New description for the KMS key.</p><important>  <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important><br>
    /// - On success, responds with [`UpdateKeyDescriptionOutput`](crate::operation::update_key_description::UpdateKeyDescriptionOutput)
    /// - On failure, responds with [`SdkError<UpdateKeyDescriptionError>`](crate::operation::update_key_description::UpdateKeyDescriptionError)
    pub fn update_key_description(&self) -> crate::operation::update_key_description::builders::UpdateKeyDescriptionFluentBuilder {
        crate::operation::update_key_description::builders::UpdateKeyDescriptionFluentBuilder::new(self.handle.clone())
    }
}