aws_sdk_kms/operation/
update_key_description.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `UpdateKeyDescription`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct UpdateKeyDescription;
6impl UpdateKeyDescription {
7    /// Creates a new `UpdateKeyDescription`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::update_key_description::UpdateKeyDescriptionInput,
14    ) -> ::std::result::Result<
15        crate::operation::update_key_description::UpdateKeyDescriptionOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::update_key_description::UpdateKeyDescriptionError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError<
22            ::aws_smithy_runtime_api::client::interceptors::context::Error,
23            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
24        >| {
25            err.map_service_error(|err| {
26                err.downcast::<crate::operation::update_key_description::UpdateKeyDescriptionError>()
27                    .expect("correct error type")
28            })
29        };
30        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
31            .await
32            .map_err(map_err)?;
33        let output = context.finalize().map_err(map_err)?;
34        ::std::result::Result::Ok(
35            output
36                .downcast::<crate::operation::update_key_description::UpdateKeyDescriptionOutput>()
37                .expect("correct output type"),
38        )
39    }
40
41    pub(crate) async fn orchestrate_with_stop_point(
42        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
43        input: crate::operation::update_key_description::UpdateKeyDescriptionInput,
44        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
45    ) -> ::std::result::Result<
46        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
47        ::aws_smithy_runtime_api::client::result::SdkError<
48            ::aws_smithy_runtime_api::client::interceptors::context::Error,
49            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
50        >,
51    > {
52        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
53        use ::tracing::Instrument;
54        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("KMS", "UpdateKeyDescription", input, runtime_plugins, stop_point)
55            // Create a parent span for the entire operation. Includes a random, internal-only,
56            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
57            .instrument(::tracing::debug_span!(
58                "KMS.UpdateKeyDescription",
59                "rpc.service" = "KMS",
60                "rpc.method" = "UpdateKeyDescription",
61                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
62                "rpc.system" = "aws-api",
63            ))
64            .await
65    }
66
67    pub(crate) fn operation_runtime_plugins(
68        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
69        client_config: &crate::config::Config,
70        config_override: ::std::option::Option<crate::config::Builder>,
71    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
72        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
73
74        if let ::std::option::Option::Some(config_override) = config_override {
75            for plugin in config_override.runtime_plugins.iter().cloned() {
76                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
77            }
78            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
79                config_override,
80                client_config.config.clone(),
81                &client_config.runtime_components,
82            ));
83        }
84        runtime_plugins
85    }
86}
87impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for UpdateKeyDescription {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("UpdateKeyDescription");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            UpdateKeyDescriptionRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            UpdateKeyDescriptionResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("UpdateKeyDescription")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "UpdateKeyDescription",
107            "KMS",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("UpdateKeyDescription")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(UpdateKeyDescriptionEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::update_key_description::UpdateKeyDescriptionError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::update_key_description::UpdateKeyDescriptionError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::update_key_description::UpdateKeyDescriptionError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct UpdateKeyDescriptionResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for UpdateKeyDescriptionResponseDeserializer {
148    fn deserialize_nonstreaming(
149        &self,
150        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
151    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
152        let (success, status) = (response.status().is_success(), response.status().as_u16());
153        let headers = response.headers();
154        let body = response.body().bytes().expect("body loaded");
155        #[allow(unused_mut)]
156        let mut force_error = false;
157        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
158        let parse_result = if !success && status != 200 || force_error {
159            crate::protocol_serde::shape_update_key_description::de_update_key_description_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_update_key_description::de_update_key_description_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct UpdateKeyDescriptionRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for UpdateKeyDescriptionRequestSerializer {
169    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
170    fn serialize_input(
171        &self,
172        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
173        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
175        let input = input
176            .downcast::<crate::operation::update_key_description::UpdateKeyDescriptionInput>()
177            .expect("correct type");
178        let _header_serialization_settings = _cfg
179            .load::<crate::serialization_settings::HeaderSerializationSettings>()
180            .cloned()
181            .unwrap_or_default();
182        let mut request_builder = {
183            fn uri_base(
184                _input: &crate::operation::update_key_description::UpdateKeyDescriptionInput,
185                output: &mut ::std::string::String,
186            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
187                use ::std::fmt::Write as _;
188                ::std::write!(output, "/").expect("formatting should succeed");
189                ::std::result::Result::Ok(())
190            }
191            #[allow(clippy::unnecessary_wraps)]
192            fn update_http_builder(
193                input: &crate::operation::update_key_description::UpdateKeyDescriptionInput,
194                builder: ::http::request::Builder,
195            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
196                let mut uri = ::std::string::String::new();
197                uri_base(input, &mut uri)?;
198                ::std::result::Result::Ok(builder.method("POST").uri(uri))
199            }
200            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
201            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
202            builder = _header_serialization_settings.set_default_header(
203                builder,
204                ::http::header::HeaderName::from_static("x-amz-target"),
205                "TrentService.UpdateKeyDescription",
206            );
207            builder
208        };
209        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_update_key_description::ser_update_key_description_input(
210            &input,
211        )?);
212        if let Some(content_length) = body.content_length() {
213            let content_length = content_length.to_string();
214            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
215        }
216        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
217    }
218}
219#[derive(Debug)]
220struct UpdateKeyDescriptionEndpointParamsInterceptor;
221
222impl ::aws_smithy_runtime_api::client::interceptors::Intercept for UpdateKeyDescriptionEndpointParamsInterceptor {
223    fn name(&self) -> &'static str {
224        "UpdateKeyDescriptionEndpointParamsInterceptor"
225    }
226
227    fn read_before_execution(
228        &self,
229        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
230            '_,
231            ::aws_smithy_runtime_api::client::interceptors::context::Input,
232            ::aws_smithy_runtime_api::client::interceptors::context::Output,
233            ::aws_smithy_runtime_api::client::interceptors::context::Error,
234        >,
235        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
236    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
237        let _input = context
238            .input()
239            .downcast_ref::<UpdateKeyDescriptionInput>()
240            .ok_or("failed to downcast to UpdateKeyDescriptionInput")?;
241
242        let params = crate::config::endpoint::Params::builder()
243            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
244            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
245            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
246            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
247            .build()
248            .map_err(|err| {
249                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
250            })?;
251        cfg.interceptor_state()
252            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
253        ::std::result::Result::Ok(())
254    }
255}
256
257// The get_* functions below are generated from JMESPath expressions in the
258// operationContextParams trait. They target the operation's input shape.
259
260/// Error type for the `UpdateKeyDescriptionError` operation.
261#[non_exhaustive]
262#[derive(::std::fmt::Debug)]
263pub enum UpdateKeyDescriptionError {
264    /// <p>The system timed out while trying to fulfill the request. You can retry the request.</p>
265    DependencyTimeoutException(crate::types::error::DependencyTimeoutException),
266    /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p>
267    InvalidArnException(crate::types::error::InvalidArnException),
268    /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p>
269    KmsInternalException(crate::types::error::KmsInternalException),
270    /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p>
271    /// <p>This exceptions means one of the following:</p>
272    /// <ul>
273    /// <li>
274    /// <p>The key state of the KMS key is not compatible with the operation.</p>
275    /// <p>To find the key state, use the <code>DescribeKey</code> operation. For more information about which key states are compatible with each KMS operation, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i> <i>Key Management Service Developer Guide</i> </i>.</p></li>
276    /// <li>
277    /// <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p></li>
278    /// </ul>
279    KmsInvalidStateException(crate::types::error::KmsInvalidStateException),
280    /// <p>The request was rejected because the specified entity or resource could not be found.</p>
281    NotFoundException(crate::types::error::NotFoundException),
282    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
283    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
284    variable wildcard pattern and check `.code()`:
285     \
286    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
287     \
288    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-UpdateKeyDescriptionError) for what information is available for the error.")]
289    Unhandled(crate::error::sealed_unhandled::Unhandled),
290}
291impl UpdateKeyDescriptionError {
292    /// Creates the `UpdateKeyDescriptionError::Unhandled` variant from any error type.
293    pub fn unhandled(
294        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
295    ) -> Self {
296        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
297            source: err.into(),
298            meta: ::std::default::Default::default(),
299        })
300    }
301
302    /// Creates the `UpdateKeyDescriptionError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
303    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
304        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
305            source: err.clone().into(),
306            meta: err,
307        })
308    }
309    ///
310    /// Returns error metadata, which includes the error code, message,
311    /// request ID, and potentially additional information.
312    ///
313    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
314        match self {
315            Self::DependencyTimeoutException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::InvalidArnException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
317            Self::KmsInternalException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
318            Self::KmsInvalidStateException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
319            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
320            Self::Unhandled(e) => &e.meta,
321        }
322    }
323    /// Returns `true` if the error kind is `UpdateKeyDescriptionError::DependencyTimeoutException`.
324    pub fn is_dependency_timeout_exception(&self) -> bool {
325        matches!(self, Self::DependencyTimeoutException(_))
326    }
327    /// Returns `true` if the error kind is `UpdateKeyDescriptionError::InvalidArnException`.
328    pub fn is_invalid_arn_exception(&self) -> bool {
329        matches!(self, Self::InvalidArnException(_))
330    }
331    /// Returns `true` if the error kind is `UpdateKeyDescriptionError::KmsInternalException`.
332    pub fn is_kms_internal_exception(&self) -> bool {
333        matches!(self, Self::KmsInternalException(_))
334    }
335    /// Returns `true` if the error kind is `UpdateKeyDescriptionError::KmsInvalidStateException`.
336    pub fn is_kms_invalid_state_exception(&self) -> bool {
337        matches!(self, Self::KmsInvalidStateException(_))
338    }
339    /// Returns `true` if the error kind is `UpdateKeyDescriptionError::NotFoundException`.
340    pub fn is_not_found_exception(&self) -> bool {
341        matches!(self, Self::NotFoundException(_))
342    }
343}
344impl ::std::error::Error for UpdateKeyDescriptionError {
345    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
346        match self {
347            Self::DependencyTimeoutException(_inner) => ::std::option::Option::Some(_inner),
348            Self::InvalidArnException(_inner) => ::std::option::Option::Some(_inner),
349            Self::KmsInternalException(_inner) => ::std::option::Option::Some(_inner),
350            Self::KmsInvalidStateException(_inner) => ::std::option::Option::Some(_inner),
351            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
352            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
353        }
354    }
355}
356impl ::std::fmt::Display for UpdateKeyDescriptionError {
357    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
358        match self {
359            Self::DependencyTimeoutException(_inner) => _inner.fmt(f),
360            Self::InvalidArnException(_inner) => _inner.fmt(f),
361            Self::KmsInternalException(_inner) => _inner.fmt(f),
362            Self::KmsInvalidStateException(_inner) => _inner.fmt(f),
363            Self::NotFoundException(_inner) => _inner.fmt(f),
364            Self::Unhandled(_inner) => {
365                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
366                    write!(f, "unhandled error ({code})")
367                } else {
368                    f.write_str("unhandled error")
369                }
370            }
371        }
372    }
373}
374impl ::aws_smithy_types::retry::ProvideErrorKind for UpdateKeyDescriptionError {
375    fn code(&self) -> ::std::option::Option<&str> {
376        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
377    }
378    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
379        ::std::option::Option::None
380    }
381}
382impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for UpdateKeyDescriptionError {
383    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
384        match self {
385            Self::DependencyTimeoutException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
386            Self::InvalidArnException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
387            Self::KmsInternalException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
388            Self::KmsInvalidStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::Unhandled(_inner) => &_inner.meta,
391        }
392    }
393}
394impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for UpdateKeyDescriptionError {
395    fn create_unhandled_error(
396        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
397        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
398    ) -> Self {
399        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
400            source,
401            meta: meta.unwrap_or_default(),
402        })
403    }
404}
405impl ::aws_types::request_id::RequestId for crate::operation::update_key_description::UpdateKeyDescriptionError {
406    fn request_id(&self) -> Option<&str> {
407        self.meta().request_id()
408    }
409}
410
411pub use crate::operation::update_key_description::_update_key_description_output::UpdateKeyDescriptionOutput;
412
413pub use crate::operation::update_key_description::_update_key_description_input::UpdateKeyDescriptionInput;
414
415mod _update_key_description_input;
416
417mod _update_key_description_output;
418
419/// Builders
420pub mod builders;
aws_sdk_kms/operation/update_key_description.rs

aws_sdk_kms/operation/
update_key_description.rs
