aws_sdk_kms/operation/
describe_custom_key_stores.rs

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

aws_sdk_kms/operation/
describe_custom_key_stores.rs
