aws_sdk_kms/operation/
get_key_rotation_status.rs

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

aws_sdk_kms/operation/
get_key_rotation_status.rs
