aws_sdk_cloudfrontkeyvaluestore/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("CloudFront KeyValueStore", "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                "CloudFront KeyValueStore.ListKeys",
55                "rpc.service" = "CloudFront KeyValueStore",
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::SensitiveOutput);
102        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
103            "ListKeys",
104            "CloudFront KeyValueStore",
105        ));
106        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
107        signing_options.double_uri_encode = true;
108        signing_options.content_sha256_header = false;
109        signing_options.normalize_uri_path = true;
110        signing_options.payload_override = None;
111
112        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
113            signing_options,
114            ..::std::default::Default::default()
115        });
116
117        ::std::option::Option::Some(cfg.freeze())
118    }
119
120    fn runtime_components(
121        &self,
122        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
123    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
124        #[allow(unused_mut)]
125        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListKeys")
126            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
127            .with_interceptor(ListKeysEndpointParamsInterceptor)
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
129                crate::operation::list_keys::ListKeysError,
130            >::new())
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
132                crate::operation::list_keys::ListKeysError,
133            >::new())
134            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
135                crate::operation::list_keys::ListKeysError,
136            >::new());
137
138        ::std::borrow::Cow::Owned(rcb)
139    }
140}
141
142#[derive(Debug)]
143struct ListKeysResponseDeserializer;
144impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListKeysResponseDeserializer {
145    fn deserialize_nonstreaming(
146        &self,
147        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
148    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
149        let (success, status) = (response.status().is_success(), response.status().as_u16());
150        let headers = response.headers();
151        let body = response.body().bytes().expect("body loaded");
152        #[allow(unused_mut)]
153        let mut force_error = false;
154        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
155        let parse_result = if !success && status != 200 || force_error {
156            crate::protocol_serde::shape_list_keys::de_list_keys_http_error(status, headers, body)
157        } else {
158            crate::protocol_serde::shape_list_keys::de_list_keys_http_response(status, headers, body)
159        };
160        crate::protocol_serde::type_erase_result(parse_result)
161    }
162}
163#[derive(Debug)]
164struct ListKeysRequestSerializer;
165impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListKeysRequestSerializer {
166    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
167    fn serialize_input(
168        &self,
169        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
170        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
171    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
172        let input = input.downcast::<crate::operation::list_keys::ListKeysInput>().expect("correct type");
173        let _header_serialization_settings = _cfg
174            .load::<crate::serialization_settings::HeaderSerializationSettings>()
175            .cloned()
176            .unwrap_or_default();
177        let mut request_builder = {
178            #[allow(clippy::uninlined_format_args)]
179            fn uri_base(
180                _input: &crate::operation::list_keys::ListKeysInput,
181                output: &mut ::std::string::String,
182            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
183                use ::std::fmt::Write as _;
184                let input_1 = &_input.kvs_arn;
185                let input_1 = input_1
186                    .as_ref()
187                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("kvs_arn", "cannot be empty or unset"))?;
188                let kvs_arn = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
189                if kvs_arn.is_empty() {
190                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
191                        "kvs_arn",
192                        "cannot be empty or unset",
193                    ));
194                }
195                ::std::write!(output, "/key-value-stores/{KvsARN}/keys", KvsARN = kvs_arn).expect("formatting should succeed");
196                ::std::result::Result::Ok(())
197            }
198            fn uri_query(
199                _input: &crate::operation::list_keys::ListKeysInput,
200                mut output: &mut ::std::string::String,
201            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
202                let mut query = ::aws_smithy_http::query::Writer::new(output);
203                if let ::std::option::Option::Some(inner_2) = &_input.next_token {
204                    {
205                        query.push_kv("NextToken", &::aws_smithy_http::query::fmt_string(inner_2));
206                    }
207                }
208                if let ::std::option::Option::Some(inner_3) = &_input.max_results {
209                    {
210                        query.push_kv("MaxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
211                    }
212                }
213                ::std::result::Result::Ok(())
214            }
215            #[allow(clippy::unnecessary_wraps)]
216            fn update_http_builder(
217                input: &crate::operation::list_keys::ListKeysInput,
218                builder: ::http::request::Builder,
219            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
220                let mut uri = ::std::string::String::new();
221                uri_base(input, &mut uri)?;
222                uri_query(input, &mut uri)?;
223                ::std::result::Result::Ok(builder.method("GET").uri(uri))
224            }
225            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
226            builder
227        };
228        let body = ::aws_smithy_types::body::SdkBody::from("");
229
230        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
231    }
232}
233#[derive(Debug)]
234struct ListKeysEndpointParamsInterceptor;
235
236impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListKeysEndpointParamsInterceptor {
237    fn name(&self) -> &'static str {
238        "ListKeysEndpointParamsInterceptor"
239    }
240
241    fn read_before_execution(
242        &self,
243        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
244            '_,
245            ::aws_smithy_runtime_api::client::interceptors::context::Input,
246            ::aws_smithy_runtime_api::client::interceptors::context::Output,
247            ::aws_smithy_runtime_api::client::interceptors::context::Error,
248        >,
249        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
250    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
251        let _input = context
252            .input()
253            .downcast_ref::<ListKeysInput>()
254            .ok_or("failed to downcast to ListKeysInput")?;
255
256        let params = crate::config::endpoint::Params::builder()
257            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
258            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
259            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
260            .set_kvs_arn(Some(
261                _input
262                    .kvs_arn
263                    .clone()
264                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
265                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("kvs_arn", "A required field was not set"))?,
266            ))
267            .build()
268            .map_err(|err| {
269                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
270            })?;
271        cfg.interceptor_state()
272            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
273        ::std::result::Result::Ok(())
274    }
275}
276
277// The get_* functions below are generated from JMESPath expressions in the
278// operationContextParams trait. They target the operation's input shape.
279
280/// Error type for the `ListKeysError` operation.
281#[non_exhaustive]
282#[derive(::std::fmt::Debug)]
283pub enum ListKeysError {
284    /// <p>Access denied.</p>
285    AccessDeniedException(crate::types::error::AccessDeniedException),
286    /// <p>Resource is not in expected state.</p>
287    ConflictException(crate::types::error::ConflictException),
288    /// <p>Internal server error.</p>
289    InternalServerException(crate::types::error::InternalServerException),
290    /// <p>Resource was not found.</p>
291    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
292    /// <p>Validation failed.</p>
293    ValidationException(crate::types::error::ValidationException),
294    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
295    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
296    variable wildcard pattern and check `.code()`:
297     \
298    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
299     \
300    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListKeysError) for what information is available for the error.")]
301    Unhandled(crate::error::sealed_unhandled::Unhandled),
302}
303impl ListKeysError {
304    /// Creates the `ListKeysError::Unhandled` variant from any error type.
305    pub fn unhandled(
306        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
307    ) -> Self {
308        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
309            source: err.into(),
310            meta: ::std::default::Default::default(),
311        })
312    }
313
314    /// Creates the `ListKeysError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
315    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
316        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
317            source: err.clone().into(),
318            meta: err,
319        })
320    }
321    ///
322    /// Returns error metadata, which includes the error code, message,
323    /// request ID, and potentially additional information.
324    ///
325    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
326        match self {
327            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::Unhandled(e) => &e.meta,
333        }
334    }
335    /// Returns `true` if the error kind is `ListKeysError::AccessDeniedException`.
336    pub fn is_access_denied_exception(&self) -> bool {
337        matches!(self, Self::AccessDeniedException(_))
338    }
339    /// Returns `true` if the error kind is `ListKeysError::ConflictException`.
340    pub fn is_conflict_exception(&self) -> bool {
341        matches!(self, Self::ConflictException(_))
342    }
343    /// Returns `true` if the error kind is `ListKeysError::InternalServerException`.
344    pub fn is_internal_server_exception(&self) -> bool {
345        matches!(self, Self::InternalServerException(_))
346    }
347    /// Returns `true` if the error kind is `ListKeysError::ResourceNotFoundException`.
348    pub fn is_resource_not_found_exception(&self) -> bool {
349        matches!(self, Self::ResourceNotFoundException(_))
350    }
351    /// Returns `true` if the error kind is `ListKeysError::ValidationException`.
352    pub fn is_validation_exception(&self) -> bool {
353        matches!(self, Self::ValidationException(_))
354    }
355}
356impl ::std::error::Error for ListKeysError {
357    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
358        match self {
359            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
360            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
361            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
362            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
363            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
364            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
365        }
366    }
367}
368impl ::std::fmt::Display for ListKeysError {
369    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
370        match self {
371            Self::AccessDeniedException(_inner) => _inner.fmt(f),
372            Self::ConflictException(_inner) => _inner.fmt(f),
373            Self::InternalServerException(_inner) => _inner.fmt(f),
374            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
375            Self::ValidationException(_inner) => _inner.fmt(f),
376            Self::Unhandled(_inner) => {
377                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
378                    write!(f, "unhandled error ({code})")
379                } else {
380                    f.write_str("unhandled error")
381                }
382            }
383        }
384    }
385}
386impl ::aws_smithy_types::retry::ProvideErrorKind for ListKeysError {
387    fn code(&self) -> ::std::option::Option<&str> {
388        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
389    }
390    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
391        ::std::option::Option::None
392    }
393}
394impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListKeysError {
395    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
396        match self {
397            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
398            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
399            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
400            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
401            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::Unhandled(_inner) => &_inner.meta,
403        }
404    }
405}
406impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListKeysError {
407    fn create_unhandled_error(
408        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
409        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
410    ) -> Self {
411        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
412            source,
413            meta: meta.unwrap_or_default(),
414        })
415    }
416}
417impl ::aws_types::request_id::RequestId for crate::operation::list_keys::ListKeysError {
418    fn request_id(&self) -> Option<&str> {
419        self.meta().request_id()
420    }
421}
422
423pub use crate::operation::list_keys::_list_keys_output::ListKeysOutput;
424
425pub use crate::operation::list_keys::_list_keys_input::ListKeysInput;
426
427mod _list_keys_input;
428
429mod _list_keys_output;
430
431/// Builders
432pub mod builders;
433
434/// Paginator for this operation
435pub mod paginator;
aws_sdk_cloudfrontkeyvaluestore/operation/list_keys.rs

aws_sdk_cloudfrontkeyvaluestore/operation/
list_keys.rs
