aws_sdk_backup/operation/
update_framework.rs

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

aws_sdk_backup/operation/
update_framework.rs
