aws_sdk_kms/operation/
disable_key.rs

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

aws_sdk_kms/operation/
disable_key.rs
