aws_sdk_backup/operation/
create_backup_plan.rs

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

aws_sdk_backup/operation/
create_backup_plan.rs
