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_api::client::interceptors::SharedInterceptor::permanent(
130                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                UpdateKeyDescriptionEndpointParamsInterceptor,
134            ))
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136                crate::operation::update_key_description::UpdateKeyDescriptionError,
137            >::new())
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139                crate::operation::update_key_description::UpdateKeyDescriptionError,
140            >::new())
141            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
142                crate::operation::update_key_description::UpdateKeyDescriptionError,
143            >::new());
144
145        ::std::borrow::Cow::Owned(rcb)
146    }
147}
148
149#[derive(Debug)]
150struct UpdateKeyDescriptionResponseDeserializer;
151impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for UpdateKeyDescriptionResponseDeserializer {
152    fn deserialize_nonstreaming_with_config(
153        &self,
154        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
155        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
156    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
157        let (success, status) = (response.status().is_success(), response.status().as_u16());
158        let headers = response.headers();
159        let body = response.body().bytes().expect("body loaded");
160        #[allow(unused_mut)]
161        let mut force_error = false;
162        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
163        let parse_result = if !success && status != 200 || force_error {
164            crate::protocol_serde::shape_update_key_description::de_update_key_description_http_error(status, headers, body)
165        } else {
166            crate::protocol_serde::shape_update_key_description::de_update_key_description_http_response(status, headers, body)
167        };
168        crate::protocol_serde::type_erase_result(parse_result)
169    }
170}
171#[derive(Debug)]
172struct UpdateKeyDescriptionRequestSerializer;
173impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for UpdateKeyDescriptionRequestSerializer {
174    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
175    fn serialize_input(
176        &self,
177        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
178        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
179    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
180        let input = input
181            .downcast::<crate::operation::update_key_description::UpdateKeyDescriptionInput>()
182            .expect("correct type");
183        let _header_serialization_settings = _cfg
184            .load::<crate::serialization_settings::HeaderSerializationSettings>()
185            .cloned()
186            .unwrap_or_default();
187        let mut request_builder = {
188            #[allow(clippy::uninlined_format_args)]
189            fn uri_base(
190                _input: &crate::operation::update_key_description::UpdateKeyDescriptionInput,
191                output: &mut ::std::string::String,
192            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
193                use ::std::fmt::Write as _;
194                ::std::write!(output, "/").expect("formatting should succeed");
195                ::std::result::Result::Ok(())
196            }
197            #[allow(clippy::unnecessary_wraps)]
198            fn update_http_builder(
199                input: &crate::operation::update_key_description::UpdateKeyDescriptionInput,
200                builder: ::http_1x::request::Builder,
201            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
202                let mut uri = ::std::string::String::new();
203                uri_base(input, &mut uri)?;
204                ::std::result::Result::Ok(builder.method("POST").uri(uri))
205            }
206            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
207            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.1");
208            builder = _header_serialization_settings.set_default_header(
209                builder,
210                ::http_1x::header::HeaderName::from_static("x-amz-target"),
211                "TrentService.UpdateKeyDescription",
212            );
213            builder
214        };
215        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_update_key_description::ser_update_key_description_input(
216            &input,
217        )?);
218        if let Some(content_length) = body.content_length() {
219            let content_length = content_length.to_string();
220            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
221        }
222        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
223    }
224}
225#[derive(Debug)]
226struct UpdateKeyDescriptionEndpointParamsInterceptor;
227
228#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
229impl ::aws_smithy_runtime_api::client::interceptors::Intercept for UpdateKeyDescriptionEndpointParamsInterceptor {
230    fn name(&self) -> &'static str {
231        "UpdateKeyDescriptionEndpointParamsInterceptor"
232    }
233
234    fn read_before_execution(
235        &self,
236        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
237            '_,
238            ::aws_smithy_runtime_api::client::interceptors::context::Input,
239            ::aws_smithy_runtime_api::client::interceptors::context::Output,
240            ::aws_smithy_runtime_api::client::interceptors::context::Error,
241        >,
242        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
243    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
244        let _input = context
245            .input()
246            .downcast_ref::<UpdateKeyDescriptionInput>()
247            .ok_or("failed to downcast to UpdateKeyDescriptionInput")?;
248
249        let params = crate::config::endpoint::Params::builder()
250            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
251            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
252            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
253            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
254            .build()
255            .map_err(|err| {
256                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
257            })?;
258        cfg.interceptor_state()
259            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
260        ::std::result::Result::Ok(())
261    }
262}
263
264// The get_* functions below are generated from JMESPath expressions in the
265// operationContextParams trait. They target the operation's input shape.
266
267/// Error type for the `UpdateKeyDescriptionError` operation.
268#[non_exhaustive]
269#[derive(::std::fmt::Debug)]
270pub enum UpdateKeyDescriptionError {
271    /// <p>The system timed out while trying to fulfill the request. You can retry the request.</p>
272    DependencyTimeoutException(crate::types::error::DependencyTimeoutException),
273    /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p>
274    InvalidArnException(crate::types::error::InvalidArnException),
275    /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p>
276    KmsInternalException(crate::types::error::KmsInternalException),
277    /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p>
278    /// <p>This exceptions means one of the following:</p>
279    /// <ul>
280    /// <li>
281    /// <p>The key state of the KMS key is not compatible with the operation.</p>
282    /// <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>
283    /// <li>
284    /// <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>
285    /// </ul>
286    KmsInvalidStateException(crate::types::error::KmsInvalidStateException),
287    /// <p>The request was rejected because the specified entity or resource could not be found.</p>
288    NotFoundException(crate::types::error::NotFoundException),
289    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
290    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
291    variable wildcard pattern and check `.code()`:
292     \
293    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
294     \
295    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-UpdateKeyDescriptionError) for what information is available for the error.")]
296    Unhandled(crate::error::sealed_unhandled::Unhandled),
297}
298impl UpdateKeyDescriptionError {
299    /// Creates the `UpdateKeyDescriptionError::Unhandled` variant from any error type.
300    pub fn unhandled(
301        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
302    ) -> Self {
303        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
304            source: err.into(),
305            meta: ::std::default::Default::default(),
306        })
307    }
308
309    /// Creates the `UpdateKeyDescriptionError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
310    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
311        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
312            source: err.clone().into(),
313            meta: err,
314        })
315    }
316    ///
317    /// Returns error metadata, which includes the error code, message,
318    /// request ID, and potentially additional information.
319    ///
320    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
321        match self {
322            Self::DependencyTimeoutException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
323            Self::InvalidArnException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
324            Self::KmsInternalException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
325            Self::KmsInvalidStateException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
326            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
327            Self::Unhandled(e) => &e.meta,
328        }
329    }
330    /// Returns `true` if the error kind is `UpdateKeyDescriptionError::DependencyTimeoutException`.
331    pub fn is_dependency_timeout_exception(&self) -> bool {
332        matches!(self, Self::DependencyTimeoutException(_))
333    }
334    /// Returns `true` if the error kind is `UpdateKeyDescriptionError::InvalidArnException`.
335    pub fn is_invalid_arn_exception(&self) -> bool {
336        matches!(self, Self::InvalidArnException(_))
337    }
338    /// Returns `true` if the error kind is `UpdateKeyDescriptionError::KmsInternalException`.
339    pub fn is_kms_internal_exception(&self) -> bool {
340        matches!(self, Self::KmsInternalException(_))
341    }
342    /// Returns `true` if the error kind is `UpdateKeyDescriptionError::KmsInvalidStateException`.
343    pub fn is_kms_invalid_state_exception(&self) -> bool {
344        matches!(self, Self::KmsInvalidStateException(_))
345    }
346    /// Returns `true` if the error kind is `UpdateKeyDescriptionError::NotFoundException`.
347    pub fn is_not_found_exception(&self) -> bool {
348        matches!(self, Self::NotFoundException(_))
349    }
350}
351impl ::std::error::Error for UpdateKeyDescriptionError {
352    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
353        match self {
354            Self::DependencyTimeoutException(_inner) => ::std::option::Option::Some(_inner),
355            Self::InvalidArnException(_inner) => ::std::option::Option::Some(_inner),
356            Self::KmsInternalException(_inner) => ::std::option::Option::Some(_inner),
357            Self::KmsInvalidStateException(_inner) => ::std::option::Option::Some(_inner),
358            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
359            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
360        }
361    }
362}
363impl ::std::fmt::Display for UpdateKeyDescriptionError {
364    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
365        match self {
366            Self::DependencyTimeoutException(_inner) => _inner.fmt(f),
367            Self::InvalidArnException(_inner) => _inner.fmt(f),
368            Self::KmsInternalException(_inner) => _inner.fmt(f),
369            Self::KmsInvalidStateException(_inner) => _inner.fmt(f),
370            Self::NotFoundException(_inner) => _inner.fmt(f),
371            Self::Unhandled(_inner) => {
372                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
373                    write!(f, "unhandled error ({code})")
374                } else {
375                    f.write_str("unhandled error")
376                }
377            }
378        }
379    }
380}
381impl ::aws_smithy_types::retry::ProvideErrorKind for UpdateKeyDescriptionError {
382    fn code(&self) -> ::std::option::Option<&str> {
383        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
384    }
385    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
386        ::std::option::Option::None
387    }
388}
389impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for UpdateKeyDescriptionError {
390    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
391        match self {
392            Self::DependencyTimeoutException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::InvalidArnException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::KmsInternalException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
395            Self::KmsInvalidStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
396            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
397            Self::Unhandled(_inner) => &_inner.meta,
398        }
399    }
400}
401impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for UpdateKeyDescriptionError {
402    fn create_unhandled_error(
403        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
404        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
405    ) -> Self {
406        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
407            source,
408            meta: meta.unwrap_or_default(),
409        })
410    }
411}
412impl ::aws_types::request_id::RequestId for crate::operation::update_key_description::UpdateKeyDescriptionError {
413    fn request_id(&self) -> Option<&str> {
414        self.meta().request_id()
415    }
416}
417
418pub use crate::operation::update_key_description::_update_key_description_input::UpdateKeyDescriptionInput;
419
420pub use crate::operation::update_key_description::_update_key_description_output::UpdateKeyDescriptionOutput;
421
422mod _update_key_description_input;
423
424mod _update_key_description_output;
425
426/// Builders
427pub mod builders;
aws_sdk_kms/operation/update_key_description.rs

aws_sdk_kms/operation/
update_key_description.rs
