aws_sdk_backup/operation/
list_backup_plans.rs

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

aws_sdk_backup/operation/
list_backup_plans.rs
