aws_sdk_kms/operation/
list_keys.rs

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