aws_sdk_kms/operation/
describe_key.rs

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

aws_sdk_kms/operation/
describe_key.rs
