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

aws_sdk_kms/operation/
describe_custom_key_stores.rs
