aws_sdk_backup/operation/
list_backup_vaults.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListBackupVaults`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListBackupVaults;
6impl ListBackupVaults {
7    /// Creates a new `ListBackupVaults`
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_backup_vaults::ListBackupVaultsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_backup_vaults::ListBackupVaultsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_backup_vaults::ListBackupVaultsError,
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::list_backup_vaults::ListBackupVaultsError>()
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::list_backup_vaults::ListBackupVaultsOutput>()
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::list_backup_vaults::ListBackupVaultsInput,
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("backup", "ListBackupVaults", 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 ListBackupVaults {
79    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
80        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListBackupVaults");
81
82        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
83            ListBackupVaultsRequestSerializer,
84        ));
85        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
86            ListBackupVaultsResponseDeserializer,
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::Metadata::new(
94            "ListBackupVaults",
95            "backup",
96        ));
97        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
98        signing_options.double_uri_encode = true;
99        signing_options.content_sha256_header = false;
100        signing_options.normalize_uri_path = true;
101        signing_options.payload_override = None;
102
103        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
104            signing_options,
105            ..::std::default::Default::default()
106        });
107
108        ::std::option::Option::Some(cfg.freeze())
109    }
110
111    fn runtime_components(
112        &self,
113        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
114    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
115        #[allow(unused_mut)]
116        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListBackupVaults")
117            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
118            .with_interceptor(ListBackupVaultsEndpointParamsInterceptor)
119            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
120                crate::operation::list_backup_vaults::ListBackupVaultsError,
121            >::new())
122            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
123                crate::operation::list_backup_vaults::ListBackupVaultsError,
124            >::new())
125            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
126                crate::operation::list_backup_vaults::ListBackupVaultsError,
127            >::new());
128
129        ::std::borrow::Cow::Owned(rcb)
130    }
131}
132
133#[derive(Debug)]
134struct ListBackupVaultsResponseDeserializer;
135impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListBackupVaultsResponseDeserializer {
136    fn deserialize_nonstreaming(
137        &self,
138        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
139    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
140        let (success, status) = (response.status().is_success(), response.status().as_u16());
141        let headers = response.headers();
142        let body = response.body().bytes().expect("body loaded");
143        #[allow(unused_mut)]
144        let mut force_error = false;
145        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
146        let parse_result = if !success && status != 200 || force_error {
147            crate::protocol_serde::shape_list_backup_vaults::de_list_backup_vaults_http_error(status, headers, body)
148        } else {
149            crate::protocol_serde::shape_list_backup_vaults::de_list_backup_vaults_http_response(status, headers, body)
150        };
151        crate::protocol_serde::type_erase_result(parse_result)
152    }
153}
154#[derive(Debug)]
155struct ListBackupVaultsRequestSerializer;
156impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListBackupVaultsRequestSerializer {
157    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
158    fn serialize_input(
159        &self,
160        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
161        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
162    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
163        let input = input
164            .downcast::<crate::operation::list_backup_vaults::ListBackupVaultsInput>()
165            .expect("correct type");
166        let _header_serialization_settings = _cfg
167            .load::<crate::serialization_settings::HeaderSerializationSettings>()
168            .cloned()
169            .unwrap_or_default();
170        let mut request_builder = {
171            fn uri_base(
172                _input: &crate::operation::list_backup_vaults::ListBackupVaultsInput,
173                output: &mut ::std::string::String,
174            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
175                use ::std::fmt::Write as _;
176                ::std::write!(output, "/backup-vaults").expect("formatting should succeed");
177                ::std::result::Result::Ok(())
178            }
179            fn uri_query(
180                _input: &crate::operation::list_backup_vaults::ListBackupVaultsInput,
181                mut output: &mut ::std::string::String,
182            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
183                let mut query = ::aws_smithy_http::query::Writer::new(output);
184                if let ::std::option::Option::Some(inner_1) = &_input.by_vault_type {
185                    {
186                        query.push_kv("vaultType", &::aws_smithy_http::query::fmt_string(inner_1));
187                    }
188                }
189                if let ::std::option::Option::Some(inner_2) = &_input.by_shared {
190                    {
191                        query.push_kv("shared", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
192                    }
193                }
194                if let ::std::option::Option::Some(inner_3) = &_input.next_token {
195                    {
196                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_3));
197                    }
198                }
199                if let ::std::option::Option::Some(inner_4) = &_input.max_results {
200                    {
201                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_4).encode());
202                    }
203                }
204                ::std::result::Result::Ok(())
205            }
206            #[allow(clippy::unnecessary_wraps)]
207            fn update_http_builder(
208                input: &crate::operation::list_backup_vaults::ListBackupVaultsInput,
209                builder: ::http::request::Builder,
210            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
211                let mut uri = ::std::string::String::new();
212                uri_base(input, &mut uri)?;
213                uri_query(input, &mut uri)?;
214                ::std::result::Result::Ok(builder.method("GET").uri(uri))
215            }
216            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
217            builder
218        };
219        let body = ::aws_smithy_types::body::SdkBody::from("");
220
221        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
222    }
223}
224#[derive(Debug)]
225struct ListBackupVaultsEndpointParamsInterceptor;
226
227impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListBackupVaultsEndpointParamsInterceptor {
228    fn name(&self) -> &'static str {
229        "ListBackupVaultsEndpointParamsInterceptor"
230    }
231
232    fn read_before_execution(
233        &self,
234        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
235            '_,
236            ::aws_smithy_runtime_api::client::interceptors::context::Input,
237            ::aws_smithy_runtime_api::client::interceptors::context::Output,
238            ::aws_smithy_runtime_api::client::interceptors::context::Error,
239        >,
240        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
241    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
242        let _input = context
243            .input()
244            .downcast_ref::<ListBackupVaultsInput>()
245            .ok_or("failed to downcast to ListBackupVaultsInput")?;
246
247        let params = crate::config::endpoint::Params::builder()
248            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
249            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
250            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
251            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
252            .build()
253            .map_err(|err| {
254                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
255            })?;
256        cfg.interceptor_state()
257            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
258        ::std::result::Result::Ok(())
259    }
260}
261
262// The get_* functions below are generated from JMESPath expressions in the
263// operationContextParams trait. They target the operation's input shape.
264
265/// Error type for the `ListBackupVaultsError` operation.
266#[non_exhaustive]
267#[derive(::std::fmt::Debug)]
268pub enum ListBackupVaultsError {
269    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
270    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
271    /// <p>Indicates that a required parameter is missing.</p>
272    MissingParameterValueException(crate::types::error::MissingParameterValueException),
273    /// <p>A resource that is required for the action doesn't exist.</p>
274    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
275    /// <p>The request failed due to a temporary failure of the server.</p>
276    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
277    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
278    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
279    variable wildcard pattern and check `.code()`:
280     \
281    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
282     \
283    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListBackupVaultsError) for what information is available for the error.")]
284    Unhandled(crate::error::sealed_unhandled::Unhandled),
285}
286impl ListBackupVaultsError {
287    /// Creates the `ListBackupVaultsError::Unhandled` variant from any error type.
288    pub fn unhandled(
289        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
290    ) -> Self {
291        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
292            source: err.into(),
293            meta: ::std::default::Default::default(),
294        })
295    }
296
297    /// Creates the `ListBackupVaultsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
298    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
299        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
300            source: err.clone().into(),
301            meta: err,
302        })
303    }
304    ///
305    /// Returns error metadata, which includes the error code, message,
306    /// request ID, and potentially additional information.
307    ///
308    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
309        match self {
310            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
311            Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
312            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::Unhandled(e) => &e.meta,
315        }
316    }
317    /// Returns `true` if the error kind is `ListBackupVaultsError::InvalidParameterValueException`.
318    pub fn is_invalid_parameter_value_exception(&self) -> bool {
319        matches!(self, Self::InvalidParameterValueException(_))
320    }
321    /// Returns `true` if the error kind is `ListBackupVaultsError::MissingParameterValueException`.
322    pub fn is_missing_parameter_value_exception(&self) -> bool {
323        matches!(self, Self::MissingParameterValueException(_))
324    }
325    /// Returns `true` if the error kind is `ListBackupVaultsError::ResourceNotFoundException`.
326    pub fn is_resource_not_found_exception(&self) -> bool {
327        matches!(self, Self::ResourceNotFoundException(_))
328    }
329    /// Returns `true` if the error kind is `ListBackupVaultsError::ServiceUnavailableException`.
330    pub fn is_service_unavailable_exception(&self) -> bool {
331        matches!(self, Self::ServiceUnavailableException(_))
332    }
333}
334impl ::std::error::Error for ListBackupVaultsError {
335    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
336        match self {
337            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
338            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
339            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
340            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
341            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
342        }
343    }
344}
345impl ::std::fmt::Display for ListBackupVaultsError {
346    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
347        match self {
348            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
349            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
350            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
351            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
352            Self::Unhandled(_inner) => {
353                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
354                    write!(f, "unhandled error ({code})")
355                } else {
356                    f.write_str("unhandled error")
357                }
358            }
359        }
360    }
361}
362impl ::aws_smithy_types::retry::ProvideErrorKind for ListBackupVaultsError {
363    fn code(&self) -> ::std::option::Option<&str> {
364        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
365    }
366    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
367        ::std::option::Option::None
368    }
369}
370impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListBackupVaultsError {
371    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
372        match self {
373            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
374            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
375            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
376            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
377            Self::Unhandled(_inner) => &_inner.meta,
378        }
379    }
380}
381impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListBackupVaultsError {
382    fn create_unhandled_error(
383        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
384        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
385    ) -> Self {
386        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
387            source,
388            meta: meta.unwrap_or_default(),
389        })
390    }
391}
392impl ::aws_types::request_id::RequestId for crate::operation::list_backup_vaults::ListBackupVaultsError {
393    fn request_id(&self) -> Option<&str> {
394        self.meta().request_id()
395    }
396}
397
398pub use crate::operation::list_backup_vaults::_list_backup_vaults_output::ListBackupVaultsOutput;
399
400pub use crate::operation::list_backup_vaults::_list_backup_vaults_input::ListBackupVaultsInput;
401
402mod _list_backup_vaults_input;
403
404mod _list_backup_vaults_output;
405
406/// Builders
407pub mod builders;
408
409/// Paginator for this operation
410pub mod paginator;