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

aws_sdk_backup/operation/
create_backup_plan.rs
