aws_sdk_kms/operation/
enable_key.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `EnableKey`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct EnableKey;
6impl EnableKey {
7    /// Creates a new `EnableKey`
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::enable_key::EnableKeyInput,
14    ) -> ::std::result::Result<
15        crate::operation::enable_key::EnableKeyOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::enable_key::EnableKeyError,
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::enable_key::EnableKeyError>()
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::enable_key::EnableKeyOutput>()
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::enable_key::EnableKeyInput,
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", "EnableKey", 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.EnableKey",
59                "rpc.service" = "KMS",
60                "rpc.method" = "EnableKey",
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        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
74            ::aws_runtime::auth::sigv4::SCHEME_ID,
75        ]));
76        if let ::std::option::Option::Some(config_override) = config_override {
77            for plugin in config_override.runtime_plugins.iter().cloned() {
78                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
79            }
80            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
81                config_override,
82                client_config.config.clone(),
83                &client_config.runtime_components,
84            ));
85        }
86        runtime_plugins
87    }
88}
89impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for EnableKey {
90    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
91        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("EnableKey");
92
93        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
94            EnableKeyRequestSerializer,
95        ));
96        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
97            EnableKeyResponseDeserializer,
98        ));
99
100        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
101            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
102        ));
103
104        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("EnableKey", "KMS"));
105        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
106        signing_options.double_uri_encode = true;
107        signing_options.content_sha256_header = false;
108        signing_options.normalize_uri_path = true;
109        signing_options.payload_override = None;
110
111        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
112            signing_options,
113            ..::std::default::Default::default()
114        });
115
116        ::std::option::Option::Some(cfg.freeze())
117    }
118
119    fn runtime_components(
120        &self,
121        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
122    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
123        #[allow(unused_mut)]
124        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("EnableKey")
125            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
126            .with_interceptor(EnableKeyEndpointParamsInterceptor)
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
128                crate::operation::enable_key::EnableKeyError,
129            >::new())
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
131                crate::operation::enable_key::EnableKeyError,
132            >::new())
133            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
134                crate::operation::enable_key::EnableKeyError,
135            >::new());
136
137        ::std::borrow::Cow::Owned(rcb)
138    }
139}
140
141#[derive(Debug)]
142struct EnableKeyResponseDeserializer;
143impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for EnableKeyResponseDeserializer {
144    fn deserialize_nonstreaming(
145        &self,
146        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
147    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
148        let (success, status) = (response.status().is_success(), response.status().as_u16());
149        let headers = response.headers();
150        let body = response.body().bytes().expect("body loaded");
151        #[allow(unused_mut)]
152        let mut force_error = false;
153        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
154        let parse_result = if !success && status != 200 || force_error {
155            crate::protocol_serde::shape_enable_key::de_enable_key_http_error(status, headers, body)
156        } else {
157            crate::protocol_serde::shape_enable_key::de_enable_key_http_response(status, headers, body)
158        };
159        crate::protocol_serde::type_erase_result(parse_result)
160    }
161}
162#[derive(Debug)]
163struct EnableKeyRequestSerializer;
164impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for EnableKeyRequestSerializer {
165    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
166    fn serialize_input(
167        &self,
168        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
169        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
171        let input = input.downcast::<crate::operation::enable_key::EnableKeyInput>().expect("correct type");
172        let _header_serialization_settings = _cfg
173            .load::<crate::serialization_settings::HeaderSerializationSettings>()
174            .cloned()
175            .unwrap_or_default();
176        let mut request_builder = {
177            fn uri_base(
178                _input: &crate::operation::enable_key::EnableKeyInput,
179                output: &mut ::std::string::String,
180            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
181                use ::std::fmt::Write as _;
182                ::std::write!(output, "/").expect("formatting should succeed");
183                ::std::result::Result::Ok(())
184            }
185            #[allow(clippy::unnecessary_wraps)]
186            fn update_http_builder(
187                input: &crate::operation::enable_key::EnableKeyInput,
188                builder: ::http::request::Builder,
189            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
190                let mut uri = ::std::string::String::new();
191                uri_base(input, &mut uri)?;
192                ::std::result::Result::Ok(builder.method("POST").uri(uri))
193            }
194            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
195            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
196            builder = _header_serialization_settings.set_default_header(
197                builder,
198                ::http::header::HeaderName::from_static("x-amz-target"),
199                "TrentService.EnableKey",
200            );
201            builder
202        };
203        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_enable_key::ser_enable_key_input(&input)?);
204        if let Some(content_length) = body.content_length() {
205            let content_length = content_length.to_string();
206            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
207        }
208        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
209    }
210}
211#[derive(Debug)]
212struct EnableKeyEndpointParamsInterceptor;
213
214impl ::aws_smithy_runtime_api::client::interceptors::Intercept for EnableKeyEndpointParamsInterceptor {
215    fn name(&self) -> &'static str {
216        "EnableKeyEndpointParamsInterceptor"
217    }
218
219    fn read_before_execution(
220        &self,
221        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
222            '_,
223            ::aws_smithy_runtime_api::client::interceptors::context::Input,
224            ::aws_smithy_runtime_api::client::interceptors::context::Output,
225            ::aws_smithy_runtime_api::client::interceptors::context::Error,
226        >,
227        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
228    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
229        let _input = context
230            .input()
231            .downcast_ref::<EnableKeyInput>()
232            .ok_or("failed to downcast to EnableKeyInput")?;
233
234        let params = crate::config::endpoint::Params::builder()
235            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
236            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
237            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
238            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
239            .build()
240            .map_err(|err| {
241                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
242            })?;
243        cfg.interceptor_state()
244            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
245        ::std::result::Result::Ok(())
246    }
247}
248
249// The get_* functions below are generated from JMESPath expressions in the
250// operationContextParams trait. They target the operation's input shape.
251
252/// Error type for the `EnableKeyError` operation.
253#[non_exhaustive]
254#[derive(::std::fmt::Debug)]
255pub enum EnableKeyError {
256    /// <p>The system timed out while trying to fulfill the request. You can retry the request.</p>
257    DependencyTimeoutException(crate::types::error::DependencyTimeoutException),
258    /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p>
259    InvalidArnException(crate::types::error::InvalidArnException),
260    /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p>
261    KmsInternalException(crate::types::error::KmsInternalException),
262    /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p>
263    /// <p>This exceptions means one of the following:</p>
264    /// <ul>
265    /// <li>
266    /// <p>The key state of the KMS key is not compatible with the operation.</p>
267    /// <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>
268    /// <li>
269    /// <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>
270    /// </ul>
271    KmsInvalidStateException(crate::types::error::KmsInvalidStateException),
272    /// <p>The request was rejected because a length constraint or quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the <i>Key Management Service Developer Guide</i>.</p>
273    LimitExceededException(crate::types::error::LimitExceededException),
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-EnableKeyError) for what information is available for the error.")]
283    Unhandled(crate::error::sealed_unhandled::Unhandled),
284}
285impl EnableKeyError {
286    /// Creates the `EnableKeyError::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 `EnableKeyError::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::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
315            Self::Unhandled(e) => &e.meta,
316        }
317    }
318    /// Returns `true` if the error kind is `EnableKeyError::DependencyTimeoutException`.
319    pub fn is_dependency_timeout_exception(&self) -> bool {
320        matches!(self, Self::DependencyTimeoutException(_))
321    }
322    /// Returns `true` if the error kind is `EnableKeyError::InvalidArnException`.
323    pub fn is_invalid_arn_exception(&self) -> bool {
324        matches!(self, Self::InvalidArnException(_))
325    }
326    /// Returns `true` if the error kind is `EnableKeyError::KmsInternalException`.
327    pub fn is_kms_internal_exception(&self) -> bool {
328        matches!(self, Self::KmsInternalException(_))
329    }
330    /// Returns `true` if the error kind is `EnableKeyError::KmsInvalidStateException`.
331    pub fn is_kms_invalid_state_exception(&self) -> bool {
332        matches!(self, Self::KmsInvalidStateException(_))
333    }
334    /// Returns `true` if the error kind is `EnableKeyError::LimitExceededException`.
335    pub fn is_limit_exceeded_exception(&self) -> bool {
336        matches!(self, Self::LimitExceededException(_))
337    }
338    /// Returns `true` if the error kind is `EnableKeyError::NotFoundException`.
339    pub fn is_not_found_exception(&self) -> bool {
340        matches!(self, Self::NotFoundException(_))
341    }
342}
343impl ::std::error::Error for EnableKeyError {
344    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
345        match self {
346            Self::DependencyTimeoutException(_inner) => ::std::option::Option::Some(_inner),
347            Self::InvalidArnException(_inner) => ::std::option::Option::Some(_inner),
348            Self::KmsInternalException(_inner) => ::std::option::Option::Some(_inner),
349            Self::KmsInvalidStateException(_inner) => ::std::option::Option::Some(_inner),
350            Self::LimitExceededException(_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 EnableKeyError {
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::LimitExceededException(_inner) => _inner.fmt(f),
364            Self::NotFoundException(_inner) => _inner.fmt(f),
365            Self::Unhandled(_inner) => {
366                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
367                    write!(f, "unhandled error ({code})")
368                } else {
369                    f.write_str("unhandled error")
370                }
371            }
372        }
373    }
374}
375impl ::aws_smithy_types::retry::ProvideErrorKind for EnableKeyError {
376    fn code(&self) -> ::std::option::Option<&str> {
377        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
378    }
379    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
380        ::std::option::Option::None
381    }
382}
383impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for EnableKeyError {
384    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
385        match self {
386            Self::DependencyTimeoutException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
387            Self::InvalidArnException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
388            Self::KmsInternalException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::KmsInvalidStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::Unhandled(_inner) => &_inner.meta,
393        }
394    }
395}
396impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for EnableKeyError {
397    fn create_unhandled_error(
398        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
399        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
400    ) -> Self {
401        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
402            source,
403            meta: meta.unwrap_or_default(),
404        })
405    }
406}
407impl ::aws_types::request_id::RequestId for crate::operation::enable_key::EnableKeyError {
408    fn request_id(&self) -> Option<&str> {
409        self.meta().request_id()
410    }
411}
412
413pub use crate::operation::enable_key::_enable_key_output::EnableKeyOutput;
414
415pub use crate::operation::enable_key::_enable_key_input::EnableKeyInput;
416
417mod _enable_key_input;
418
419mod _enable_key_output;
420
421/// Builders
422pub mod builders;
aws_sdk_kms/operation/enable_key.rs

aws_sdk_kms/operation/
enable_key.rs
