aws_sdk_kms/operation/update_key_description/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_key_description::_update_key_description_output::UpdateKeyDescriptionOutputBuilder;
3
4pub use crate::operation::update_key_description::_update_key_description_input::UpdateKeyDescriptionInputBuilder;
5
6impl crate::operation::update_key_description::builders::UpdateKeyDescriptionInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::update_key_description::UpdateKeyDescriptionOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::update_key_description::UpdateKeyDescriptionError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.update_key_description();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `UpdateKeyDescription`.
24///
25/// <p>Updates the description of a KMS key. To see the description of a KMS key, use <code>DescribeKey</code>.</p>
26/// <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
27/// <p><b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
28/// <p><b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateKeyDescription</a> (key policy)</p>
29/// <p><b>Related operations</b></p>
30/// <ul>
31/// <li>
32/// <p><code>CreateKey</code></p></li>
33/// <li>
34/// <p><code>DescribeKey</code></p></li>
35/// </ul>
36/// <p><b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
37#[derive(::std::clone::Clone, ::std::fmt::Debug)]
38pub struct UpdateKeyDescriptionFluentBuilder {
39 handle: ::std::sync::Arc<crate::client::Handle>,
40 inner: crate::operation::update_key_description::builders::UpdateKeyDescriptionInputBuilder,
41 config_override: ::std::option::Option<crate::config::Builder>,
42}
43impl
44 crate::client::customize::internal::CustomizableSend<
45 crate::operation::update_key_description::UpdateKeyDescriptionOutput,
46 crate::operation::update_key_description::UpdateKeyDescriptionError,
47 > for UpdateKeyDescriptionFluentBuilder
48{
49 fn send(
50 self,
51 config_override: crate::config::Builder,
52 ) -> crate::client::customize::internal::BoxFuture<
53 crate::client::customize::internal::SendResult<
54 crate::operation::update_key_description::UpdateKeyDescriptionOutput,
55 crate::operation::update_key_description::UpdateKeyDescriptionError,
56 >,
57 > {
58 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
59 }
60}
61impl UpdateKeyDescriptionFluentBuilder {
62 /// Creates a new `UpdateKeyDescriptionFluentBuilder`.
63 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
64 Self {
65 handle,
66 inner: ::std::default::Default::default(),
67 config_override: ::std::option::Option::None,
68 }
69 }
70 /// Access the UpdateKeyDescription as a reference.
71 pub fn as_input(&self) -> &crate::operation::update_key_description::builders::UpdateKeyDescriptionInputBuilder {
72 &self.inner
73 }
74 /// Sends the request and returns the response.
75 ///
76 /// If an error occurs, an `SdkError` will be returned with additional details that
77 /// can be matched against.
78 ///
79 /// By default, any retryable failures will be retried twice. Retry behavior
80 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
81 /// set when configuring the client.
82 pub async fn send(
83 self,
84 ) -> ::std::result::Result<
85 crate::operation::update_key_description::UpdateKeyDescriptionOutput,
86 ::aws_smithy_runtime_api::client::result::SdkError<
87 crate::operation::update_key_description::UpdateKeyDescriptionError,
88 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
89 >,
90 > {
91 let input = self
92 .inner
93 .build()
94 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
95 let runtime_plugins = crate::operation::update_key_description::UpdateKeyDescription::operation_runtime_plugins(
96 self.handle.runtime_plugins.clone(),
97 &self.handle.conf,
98 self.config_override,
99 );
100 crate::operation::update_key_description::UpdateKeyDescription::orchestrate(&runtime_plugins, input).await
101 }
102
103 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
104 pub fn customize(
105 self,
106 ) -> crate::client::customize::CustomizableOperation<
107 crate::operation::update_key_description::UpdateKeyDescriptionOutput,
108 crate::operation::update_key_description::UpdateKeyDescriptionError,
109 Self,
110 > {
111 crate::client::customize::CustomizableOperation::new(self)
112 }
113 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
114 self.set_config_override(::std::option::Option::Some(config_override.into()));
115 self
116 }
117
118 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
119 self.config_override = config_override;
120 self
121 }
122 /// <p>Updates the description of the specified KMS key.</p>
123 /// <p>Specify the key ID or key ARN of the KMS key.</p>
124 /// <p>For example:</p>
125 /// <ul>
126 /// <li>
127 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
128 /// <li>
129 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
130 /// </ul>
131 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
132 pub fn key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133 self.inner = self.inner.key_id(input.into());
134 self
135 }
136 /// <p>Updates the description of the specified KMS key.</p>
137 /// <p>Specify the key ID or key ARN of the KMS key.</p>
138 /// <p>For example:</p>
139 /// <ul>
140 /// <li>
141 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
142 /// <li>
143 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
144 /// </ul>
145 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
146 pub fn set_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
147 self.inner = self.inner.set_key_id(input);
148 self
149 }
150 /// <p>Updates the description of the specified KMS key.</p>
151 /// <p>Specify the key ID or key ARN of the KMS key.</p>
152 /// <p>For example:</p>
153 /// <ul>
154 /// <li>
155 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
156 /// <li>
157 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
158 /// </ul>
159 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
160 pub fn get_key_id(&self) -> &::std::option::Option<::std::string::String> {
161 self.inner.get_key_id()
162 }
163 /// <p>New description for the KMS key.</p><important>
164 /// <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>
165 /// </important>
166 pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
167 self.inner = self.inner.description(input.into());
168 self
169 }
170 /// <p>New description for the KMS key.</p><important>
171 /// <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>
172 /// </important>
173 pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
174 self.inner = self.inner.set_description(input);
175 self
176 }
177 /// <p>New description for the KMS key.</p><important>
178 /// <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>
179 /// </important>
180 pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
181 self.inner.get_description()
182 }
183}