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        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.CreateBackupPlan",
36                "rpc.service" = "backup",
37                "rpc.method" = "CreateBackupPlan",
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::create_backup_plan::CreateBackupPlanOutput>()
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::create_backup_plan::CreateBackupPlanInput,
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", "CreateBackupPlan", 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 CreateBackupPlan {
89    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
90        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("CreateBackupPlan");
91
92        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
93            CreateBackupPlanRequestSerializer,
94        ));
95        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
96            CreateBackupPlanResponseDeserializer,
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(
104            "CreateBackupPlan",
105            "backup",
106        ));
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("CreateBackupPlan")
127            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
128            .with_interceptor(CreateBackupPlanEndpointParamsInterceptor)
129            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
130                crate::operation::create_backup_plan::CreateBackupPlanError,
131            >::new())
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
133                crate::operation::create_backup_plan::CreateBackupPlanError,
134            >::new())
135            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
136                crate::operation::create_backup_plan::CreateBackupPlanError,
137            >::new());
138
139        ::std::borrow::Cow::Owned(rcb)
140    }
141}
142
143#[derive(Debug)]
144struct CreateBackupPlanResponseDeserializer;
145impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for CreateBackupPlanResponseDeserializer {
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_create_backup_plan::de_create_backup_plan_http_error(status, headers, body)
158        } else {
159            crate::protocol_serde::shape_create_backup_plan::de_create_backup_plan_http_response(status, headers, body)
160        };
161        crate::protocol_serde::type_erase_result(parse_result)
162    }
163}
164#[derive(Debug)]
165struct CreateBackupPlanRequestSerializer;
166impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for CreateBackupPlanRequestSerializer {
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::create_backup_plan::CreateBackupPlanInput>()
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::create_backup_plan::CreateBackupPlanInput,
183                output: &mut ::std::string::String,
184            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
185                use ::std::fmt::Write as _;
186                ::std::write!(output, "/backup/plans").expect("formatting should succeed");
187                ::std::result::Result::Ok(())
188            }
189            #[allow(clippy::unnecessary_wraps)]
190            fn update_http_builder(
191                input: &crate::operation::create_backup_plan::CreateBackupPlanInput,
192                builder: ::http::request::Builder,
193            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
194                let mut uri = ::std::string::String::new();
195                uri_base(input, &mut uri)?;
196                ::std::result::Result::Ok(builder.method("PUT").uri(uri))
197            }
198            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
199            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/json");
200            builder
201        };
202        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_create_backup_plan::ser_create_backup_plan_input(&input)?);
203        if let Some(content_length) = body.content_length() {
204            let content_length = content_length.to_string();
205            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
206        }
207        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
208    }
209}
210#[derive(Debug)]
211struct CreateBackupPlanEndpointParamsInterceptor;
212
213impl ::aws_smithy_runtime_api::client::interceptors::Intercept for CreateBackupPlanEndpointParamsInterceptor {
214    fn name(&self) -> &'static str {
215        "CreateBackupPlanEndpointParamsInterceptor"
216    }
217
218    fn read_before_execution(
219        &self,
220        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
221            '_,
222            ::aws_smithy_runtime_api::client::interceptors::context::Input,
223            ::aws_smithy_runtime_api::client::interceptors::context::Output,
224            ::aws_smithy_runtime_api::client::interceptors::context::Error,
225        >,
226        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
227    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
228        let _input = context
229            .input()
230            .downcast_ref::<CreateBackupPlanInput>()
231            .ok_or("failed to downcast to CreateBackupPlanInput")?;
232
233        let params = crate::config::endpoint::Params::builder()
234            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
235            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
236            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
237            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
238            .build()
239            .map_err(|err| {
240                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
241            })?;
242        cfg.interceptor_state()
243            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
244        ::std::result::Result::Ok(())
245    }
246}
247
248// The get_* functions below are generated from JMESPath expressions in the
249// operationContextParams trait. They target the operation's input shape.
250
251/// Error type for the `CreateBackupPlanError` operation.
252#[non_exhaustive]
253#[derive(::std::fmt::Debug)]
254pub enum CreateBackupPlanError {
255    /// <p>The required resource already exists.</p>
256    AlreadyExistsException(crate::types::error::AlreadyExistsException),
257    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
258    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
259    /// <p>A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.</p>
260    LimitExceededException(crate::types::error::LimitExceededException),
261    /// <p>Indicates that a required parameter is missing.</p>
262    MissingParameterValueException(crate::types::error::MissingParameterValueException),
263    /// <p>The request failed due to a temporary failure of the server.</p>
264    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
265    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
266    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
267    variable wildcard pattern and check `.code()`:
268     \
269    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
270     \
271    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-CreateBackupPlanError) for what information is available for the error.")]
272    Unhandled(crate::error::sealed_unhandled::Unhandled),
273}
274impl CreateBackupPlanError {
275    /// Creates the `CreateBackupPlanError::Unhandled` variant from any error type.
276    pub fn unhandled(
277        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
278    ) -> Self {
279        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
280            source: err.into(),
281            meta: ::std::default::Default::default(),
282        })
283    }
284
285    /// Creates the `CreateBackupPlanError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
286    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
287        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
288            source: err.clone().into(),
289            meta: err,
290        })
291    }
292    ///
293    /// Returns error metadata, which includes the error code, message,
294    /// request ID, and potentially additional information.
295    ///
296    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
297        match self {
298            Self::AlreadyExistsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
299            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
300            Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
301            Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
302            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
303            Self::Unhandled(e) => &e.meta,
304        }
305    }
306    /// Returns `true` if the error kind is `CreateBackupPlanError::AlreadyExistsException`.
307    pub fn is_already_exists_exception(&self) -> bool {
308        matches!(self, Self::AlreadyExistsException(_))
309    }
310    /// Returns `true` if the error kind is `CreateBackupPlanError::InvalidParameterValueException`.
311    pub fn is_invalid_parameter_value_exception(&self) -> bool {
312        matches!(self, Self::InvalidParameterValueException(_))
313    }
314    /// Returns `true` if the error kind is `CreateBackupPlanError::LimitExceededException`.
315    pub fn is_limit_exceeded_exception(&self) -> bool {
316        matches!(self, Self::LimitExceededException(_))
317    }
318    /// Returns `true` if the error kind is `CreateBackupPlanError::MissingParameterValueException`.
319    pub fn is_missing_parameter_value_exception(&self) -> bool {
320        matches!(self, Self::MissingParameterValueException(_))
321    }
322    /// Returns `true` if the error kind is `CreateBackupPlanError::ServiceUnavailableException`.
323    pub fn is_service_unavailable_exception(&self) -> bool {
324        matches!(self, Self::ServiceUnavailableException(_))
325    }
326}
327impl ::std::error::Error for CreateBackupPlanError {
328    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
329        match self {
330            Self::AlreadyExistsException(_inner) => ::std::option::Option::Some(_inner),
331            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
332            Self::LimitExceededException(_inner) => ::std::option::Option::Some(_inner),
333            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
334            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
335            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
336        }
337    }
338}
339impl ::std::fmt::Display for CreateBackupPlanError {
340    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
341        match self {
342            Self::AlreadyExistsException(_inner) => _inner.fmt(f),
343            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
344            Self::LimitExceededException(_inner) => _inner.fmt(f),
345            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
346            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
347            Self::Unhandled(_inner) => {
348                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
349                    write!(f, "unhandled error ({code})")
350                } else {
351                    f.write_str("unhandled error")
352                }
353            }
354        }
355    }
356}
357impl ::aws_smithy_types::retry::ProvideErrorKind for CreateBackupPlanError {
358    fn code(&self) -> ::std::option::Option<&str> {
359        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
360    }
361    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
362        ::std::option::Option::None
363    }
364}
365impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for CreateBackupPlanError {
366    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
367        match self {
368            Self::AlreadyExistsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
369            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
370            Self::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
371            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
372            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
373            Self::Unhandled(_inner) => &_inner.meta,
374        }
375    }
376}
377impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for CreateBackupPlanError {
378    fn create_unhandled_error(
379        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
380        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
381    ) -> Self {
382        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
383            source,
384            meta: meta.unwrap_or_default(),
385        })
386    }
387}
388impl ::aws_types::request_id::RequestId for crate::operation::create_backup_plan::CreateBackupPlanError {
389    fn request_id(&self) -> Option<&str> {
390        self.meta().request_id()
391    }
392}
393
394pub use crate::operation::create_backup_plan::_create_backup_plan_output::CreateBackupPlanOutput;
395
396pub use crate::operation::create_backup_plan::_create_backup_plan_input::CreateBackupPlanInput;
397
398mod _create_backup_plan_input;
399
400mod _create_backup_plan_output;
401
402/// Builders
403pub mod builders;
aws_sdk_backup/operation/create_backup_plan.rs

aws_sdk_backup/operation/
create_backup_plan.rs
