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

aws_sdk_backup/operation/
list_backup_plans.rs
