Struct aws_sdk_kms::client::fluent_builders::UpdateKeyDescription

pub struct UpdateKeyDescription { /* private fields */ }

Fluent builder constructing a request to UpdateKeyDescription.

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys 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:UpdateKeyDescription (key policy)

Related operations

• CreateKey

• DescribeKey

Implementations

impl UpdateKeyDescription

pub async fn customize(
    self
) -> Result<CustomizableOperation<UpdateKeyDescription, AwsResponseRetryClassifier>, SdkError<UpdateKeyDescriptionError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<UpdateKeyDescriptionOutput, SdkError<UpdateKeyDescriptionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn key_id(self, input: impl Into<String>) -> Self

Updates the description of 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.

pub fn set_key_id(self, input: Option<String>) -> Self

Updates the description of 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.

pub fn description(self, input: impl Into<String>) -> Self

New description for the KMS key.

pub fn set_description(self, input: Option<String>) -> Self

New description for the KMS key.

Trait Implementations

impl Clone for UpdateKeyDescription

fn clone(&self) -> UpdateKeyDescription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateKeyDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.