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        use ::tracing::Instrument;
50        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("KMS", "ListKeys", input, runtime_plugins, stop_point)
51            // Create a parent span for the entire operation. Includes a random, internal-only,
52            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
53            .instrument(::tracing::debug_span!(
54                "KMS.ListKeys",
55                "rpc.service" = "KMS",
56                "rpc.method" = "ListKeys",
57                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
58                "rpc.system" = "aws-api",
59            ))
60            .await
61    }
62
63    pub(crate) fn operation_runtime_plugins(
64        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
65        client_config: &crate::config::Config,
66        config_override: ::std::option::Option<crate::config::Builder>,
67    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
68        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
69
70        if let ::std::option::Option::Some(config_override) = config_override {
71            for plugin in config_override.runtime_plugins.iter().cloned() {
72                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
73            }
74            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
75                config_override,
76                client_config.config.clone(),
77                &client_config.runtime_components,
78            ));
79        }
80        runtime_plugins
81    }
82}
83impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ListKeys {
84    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
85        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListKeys");
86
87        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
88            ListKeysRequestSerializer,
89        ));
90        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
91            ListKeysResponseDeserializer,
92        ));
93
94        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
95            crate::config::auth::Params::builder()
96                .operation_name("ListKeys")
97                .build()
98                .expect("required fields set"),
99        ));
100
101        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListKeys", "KMS"));
102        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
103        signing_options.double_uri_encode = true;
104        signing_options.content_sha256_header = false;
105        signing_options.normalize_uri_path = true;
106        signing_options.payload_override = None;
107
108        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
109            signing_options,
110            ..::std::default::Default::default()
111        });
112
113        ::std::option::Option::Some(cfg.freeze())
114    }
115
116    fn runtime_components(
117        &self,
118        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
119    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
120        #[allow(unused_mut)]
121        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListKeys")
122            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
123                ListKeysTelemetryInputCaptureInterceptor,
124            ))
125            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
126                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
127            ))
128            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
129                ListKeysEndpointParamsInterceptor,
130            ))
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::list_keys::ListKeysError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::list_keys::ListKeysError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::list_keys::ListKeysError,
139            >::new())
140            .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
141                crate::operation::list_keys::ListKeysError,
142            >::new());
143
144        ::std::borrow::Cow::Owned(rcb)
145    }
146}
147
148#[derive(Debug)]
149struct ListKeysTelemetryInputCaptureInterceptor;
150
151#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
152impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListKeysTelemetryInputCaptureInterceptor {
153    fn name(&self) -> &'static str {
154        "ListKeysTelemetryInputCaptureInterceptor"
155    }
156
157    fn read_before_execution(
158        &self,
159        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
160            '_,
161            ::aws_smithy_runtime_api::client::interceptors::context::Input,
162            ::aws_smithy_runtime_api::client::interceptors::context::Output,
163            ::aws_smithy_runtime_api::client::interceptors::context::Error,
164        >,
165        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
166    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
167        // Nothing to do unless the customer opted in by naming members to record.
168        let ::std::option::Option::Some(requested) = cfg
169            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
170            .filter(|r| !r.is_empty())
171        else {
172            return ::std::result::Result::Ok(());
173        };
174
175        let ::std::option::Option::Some(input) = context.input().downcast_ref::<ListKeysInput>() else {
176            // A mismatched input is not this interceptor's concern; skip quietly.
177            return ::std::result::Result::Ok(());
178        };
179
180        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
181        if requested.should_capture("Marker") {
182            if let ::std::option::Option::Some(value) = input.marker.as_deref() {
183                captured.insert("Marker", value);
184            }
185        }
186
187        cfg.interceptor_state().store_put(captured);
188        ::std::result::Result::Ok(())
189    }
190}
191#[derive(Debug)]
192struct ListKeysResponseDeserializer;
193impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListKeysResponseDeserializer {
194    fn deserialize_nonstreaming_with_config(
195        &self,
196        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
197        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
198    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
199        let (success, status) = (response.status().is_success(), response.status().as_u16());
200        let headers = response.headers();
201        let body = response.body().bytes().expect("body loaded");
202        #[allow(unused_mut)]
203        let mut force_error = false;
204        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
205        let parse_result = if !success && status != 200 || force_error {
206            crate::protocol_serde::shape_list_keys::de_list_keys_http_error(status, headers, body, _cfg)
207        } else {
208            crate::protocol_serde::shape_list_keys::de_list_keys_http_response(status, headers, body, _cfg)
209        };
210        crate::protocol_serde::type_erase_result(parse_result)
211    }
212}
213#[derive(Debug)]
214struct ListKeysRequestSerializer;
215impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListKeysRequestSerializer {
216    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
217    fn serialize_input(
218        &self,
219        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
220        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
221    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
222        let input = input.downcast::<crate::operation::list_keys::ListKeysInput>().expect("correct type");
223        let _header_serialization_settings = _cfg
224            .load::<crate::serialization_settings::HeaderSerializationSettings>()
225            .cloned()
226            .unwrap_or_default();
227        let mut request_builder = {
228            #[allow(clippy::uninlined_format_args)]
229            fn uri_base(
230                _input: &crate::operation::list_keys::ListKeysInput,
231                output: &mut ::std::string::String,
232            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
233                use ::std::fmt::Write as _;
234                ::std::write!(output, "/").expect("formatting should succeed");
235                ::std::result::Result::Ok(())
236            }
237            #[allow(clippy::unnecessary_wraps)]
238            fn update_http_builder(
239                input: &crate::operation::list_keys::ListKeysInput,
240                builder: ::http_1x::request::Builder,
241            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
242                let mut uri = ::std::string::String::new();
243                uri_base(input, &mut uri)?;
244                ::std::result::Result::Ok(builder.method("POST").uri(uri))
245            }
246            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
247            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.1");
248            builder = _header_serialization_settings.set_default_header(
249                builder,
250                ::http_1x::header::HeaderName::from_static("x-amz-target"),
251                "TrentService.ListKeys",
252            );
253            builder
254        };
255        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_list_keys::ser_list_keys_input(&input)?);
256        if let Some(content_length) = body.content_length() {
257            let content_length = content_length.to_string();
258            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
259        }
260        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
261    }
262}
263#[derive(Debug)]
264struct ListKeysEndpointParamsInterceptor;
265
266#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
267impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListKeysEndpointParamsInterceptor {
268    fn name(&self) -> &'static str {
269        "ListKeysEndpointParamsInterceptor"
270    }
271
272    fn read_before_execution(
273        &self,
274        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
275            '_,
276            ::aws_smithy_runtime_api::client::interceptors::context::Input,
277            ::aws_smithy_runtime_api::client::interceptors::context::Output,
278            ::aws_smithy_runtime_api::client::interceptors::context::Error,
279        >,
280        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
281    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
282        let _input = context
283            .input()
284            .downcast_ref::<ListKeysInput>()
285            .ok_or("failed to downcast to ListKeysInput")?;
286
287        let params = crate::config::endpoint::Params::builder()
288            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
289            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
290            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
291            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
292            .build()
293            .map_err(|err| {
294                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
295            })?;
296        cfg.interceptor_state()
297            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
298        ::std::result::Result::Ok(())
299    }
300}
301
302// The get_* functions below are generated from JMESPath expressions in the
303// operationContextParams trait. They target the operation's input shape.
304
305/// Error type for the `ListKeysError` operation.
306#[non_exhaustive]
307#[derive(::std::fmt::Debug)]
308pub enum ListKeysError {
309    /// <p>The system timed out while trying to fulfill the request. You can retry the request.</p>
310    DependencyTimeoutException(crate::types::error::DependencyTimeoutException),
311    /// <p>The request was rejected because the marker that specifies where pagination should next begin is not valid.</p>
312    InvalidMarkerException(crate::types::error::InvalidMarkerException),
313    /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p>
314    KmsInternalException(crate::types::error::KmsInternalException),
315    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
316    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
317    variable wildcard pattern and check `.code()`:
318     \
319    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
320     \
321    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListKeysError) for what information is available for the error.")]
322    Unhandled(crate::error::sealed_unhandled::Unhandled),
323}
324impl ListKeysError {
325    /// Creates the `ListKeysError::Unhandled` variant from any error type.
326    pub fn unhandled(
327        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
328    ) -> Self {
329        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
330            source: err.into(),
331            meta: ::std::default::Default::default(),
332        })
333    }
334
335    /// Creates the `ListKeysError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
336    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
337        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
338            source: err.clone().into(),
339            meta: err,
340        })
341    }
342    ///
343    /// Returns error metadata, which includes the error code, message,
344    /// request ID, and potentially additional information.
345    ///
346    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
347        match self {
348            Self::DependencyTimeoutException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
349            Self::InvalidMarkerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
350            Self::KmsInternalException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
351            Self::Unhandled(e) => &e.meta,
352        }
353    }
354    /// Returns `true` if the error kind is `ListKeysError::DependencyTimeoutException`.
355    pub fn is_dependency_timeout_exception(&self) -> bool {
356        matches!(self, Self::DependencyTimeoutException(_))
357    }
358    /// Returns `true` if the error kind is `ListKeysError::InvalidMarkerException`.
359    pub fn is_invalid_marker_exception(&self) -> bool {
360        matches!(self, Self::InvalidMarkerException(_))
361    }
362    /// Returns `true` if the error kind is `ListKeysError::KmsInternalException`.
363    pub fn is_kms_internal_exception(&self) -> bool {
364        matches!(self, Self::KmsInternalException(_))
365    }
366}
367impl ::std::error::Error for ListKeysError {
368    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
369        match self {
370            Self::DependencyTimeoutException(_inner) => ::std::option::Option::Some(_inner),
371            Self::InvalidMarkerException(_inner) => ::std::option::Option::Some(_inner),
372            Self::KmsInternalException(_inner) => ::std::option::Option::Some(_inner),
373            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
374        }
375    }
376}
377impl ::std::fmt::Display for ListKeysError {
378    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
379        match self {
380            Self::DependencyTimeoutException(_inner) => _inner.fmt(f),
381            Self::InvalidMarkerException(_inner) => _inner.fmt(f),
382            Self::KmsInternalException(_inner) => _inner.fmt(f),
383            Self::Unhandled(_inner) => {
384                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
385                    write!(f, "unhandled error ({code})")
386                } else {
387                    f.write_str("unhandled error")
388                }
389            }
390        }
391    }
392}
393impl ::aws_smithy_types::retry::ProvideErrorKind for ListKeysError {
394    fn code(&self) -> ::std::option::Option<&str> {
395        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
396    }
397    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
398        ::std::option::Option::None
399    }
400}
401impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListKeysError {
402    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
403        match self {
404            Self::DependencyTimeoutException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
405            Self::InvalidMarkerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::KmsInternalException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
407            Self::Unhandled(_inner) => &_inner.meta,
408        }
409    }
410}
411impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListKeysError {
412    fn create_unhandled_error(
413        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
414        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
415    ) -> Self {
416        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
417            source,
418            meta: meta.unwrap_or_default(),
419        })
420    }
421}
422impl ::aws_types::request_id::RequestId for crate::operation::list_keys::ListKeysError {
423    fn request_id(&self) -> Option<&str> {
424        self.meta().request_id()
425    }
426}
427
428pub use crate::operation::list_keys::_list_keys_input::ListKeysInput;
429
430pub use crate::operation::list_keys::_list_keys_output::ListKeysOutput;
431
432mod _list_keys_input;
433
434mod _list_keys_output;
435
436/// Builders
437pub mod builders;
438
439/// Paginator for this operation
440pub mod paginator;
aws_sdk_kms/operation/list_keys.rs

aws_sdk_kms/operation/
list_keys.rs
