aws_sdk_backup/operation/
get_backup_plan.rs

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

aws_sdk_backup/operation/
get_backup_plan.rs
