aws_sdk_rbin/operation/
lock_rule.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `LockRule`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct LockRule;
6impl LockRule {
7    /// Creates a new `LockRule`
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::lock_rule::LockRuleInput,
14    ) -> ::std::result::Result<
15        crate::operation::lock_rule::LockRuleOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::lock_rule::LockRuleError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::lock_rule::LockRuleError>().expect("correct error type")) };
26        use ::tracing::Instrument;
27        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
28            // Create a parent span for the entire operation. Includes a random, internal-only,
29            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
30            .instrument(::tracing::debug_span!(
31                "rbin.LockRule",
32                "rpc.service" = "rbin",
33                "rpc.method" = "LockRule",
34                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
35                "rpc.system" = "aws-api",
36            ))
37            .await
38            .map_err(map_err)?;
39        let output = context.finalize().map_err(map_err)?;
40        ::std::result::Result::Ok(
41            output
42                .downcast::<crate::operation::lock_rule::LockRuleOutput>()
43                .expect("correct output type"),
44        )
45    }
46
47    pub(crate) async fn orchestrate_with_stop_point(
48        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
49        input: crate::operation::lock_rule::LockRuleInput,
50        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
51    ) -> ::std::result::Result<
52        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
53        ::aws_smithy_runtime_api::client::result::SdkError<
54            ::aws_smithy_runtime_api::client::interceptors::context::Error,
55            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
56        >,
57    > {
58        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
59        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("rbin", "LockRule", input, runtime_plugins, stop_point).await
60    }
61
62    pub(crate) fn operation_runtime_plugins(
63        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
64        client_config: &crate::config::Config,
65        config_override: ::std::option::Option<crate::config::Builder>,
66    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
67        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
68        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
69            ::aws_runtime::auth::sigv4::SCHEME_ID,
70        ]));
71        if let ::std::option::Option::Some(config_override) = config_override {
72            for plugin in config_override.runtime_plugins.iter().cloned() {
73                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
74            }
75            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
76                config_override,
77                client_config.config.clone(),
78                &client_config.runtime_components,
79            ));
80        }
81        runtime_plugins
82    }
83}
84impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for LockRule {
85    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
86        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("LockRule");
87
88        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
89            LockRuleRequestSerializer,
90        ));
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
92            LockRuleResponseDeserializer,
93        ));
94
95        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
96            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
97        ));
98
99        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("LockRule", "rbin"));
100        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
101        signing_options.double_uri_encode = true;
102        signing_options.content_sha256_header = false;
103        signing_options.normalize_uri_path = true;
104        signing_options.payload_override = None;
105
106        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
107            signing_options,
108            ..::std::default::Default::default()
109        });
110
111        ::std::option::Option::Some(cfg.freeze())
112    }
113
114    fn runtime_components(
115        &self,
116        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
117    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
118        #[allow(unused_mut)]
119        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("LockRule")
120            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
121            .with_interceptor(LockRuleEndpointParamsInterceptor)
122            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
123                crate::operation::lock_rule::LockRuleError,
124            >::new())
125            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
126                crate::operation::lock_rule::LockRuleError,
127            >::new())
128            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
129                crate::operation::lock_rule::LockRuleError,
130            >::new());
131
132        ::std::borrow::Cow::Owned(rcb)
133    }
134}
135
136#[derive(Debug)]
137struct LockRuleResponseDeserializer;
138impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for LockRuleResponseDeserializer {
139    fn deserialize_nonstreaming(
140        &self,
141        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
142    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
143        let (success, status) = (response.status().is_success(), response.status().as_u16());
144        let headers = response.headers();
145        let body = response.body().bytes().expect("body loaded");
146        #[allow(unused_mut)]
147        let mut force_error = false;
148        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
149        let parse_result = if !success && status != 200 || force_error {
150            crate::protocol_serde::shape_lock_rule::de_lock_rule_http_error(status, headers, body)
151        } else {
152            crate::protocol_serde::shape_lock_rule::de_lock_rule_http_response(status, headers, body)
153        };
154        crate::protocol_serde::type_erase_result(parse_result)
155    }
156}
157#[derive(Debug)]
158struct LockRuleRequestSerializer;
159impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for LockRuleRequestSerializer {
160    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
161    fn serialize_input(
162        &self,
163        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
164        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
165    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
166        let input = input.downcast::<crate::operation::lock_rule::LockRuleInput>().expect("correct type");
167        let _header_serialization_settings = _cfg
168            .load::<crate::serialization_settings::HeaderSerializationSettings>()
169            .cloned()
170            .unwrap_or_default();
171        let mut request_builder = {
172            fn uri_base(
173                _input: &crate::operation::lock_rule::LockRuleInput,
174                output: &mut ::std::string::String,
175            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
176                use ::std::fmt::Write as _;
177                let input_1 = &_input.identifier;
178                let input_1 = input_1
179                    .as_ref()
180                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("identifier", "cannot be empty or unset"))?;
181                let identifier = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
182                if identifier.is_empty() {
183                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
184                        "identifier",
185                        "cannot be empty or unset",
186                    ));
187                }
188                ::std::write!(output, "/rules/{Identifier}/lock", Identifier = identifier).expect("formatting should succeed");
189                ::std::result::Result::Ok(())
190            }
191            #[allow(clippy::unnecessary_wraps)]
192            fn update_http_builder(
193                input: &crate::operation::lock_rule::LockRuleInput,
194                builder: ::http::request::Builder,
195            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
196                let mut uri = ::std::string::String::new();
197                uri_base(input, &mut uri)?;
198                ::std::result::Result::Ok(builder.method("PATCH").uri(uri))
199            }
200            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
201            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/json");
202            builder
203        };
204        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_lock_rule::ser_lock_rule_input(&input)?);
205        if let Some(content_length) = body.content_length() {
206            let content_length = content_length.to_string();
207            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
208        }
209        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
210    }
211}
212#[derive(Debug)]
213struct LockRuleEndpointParamsInterceptor;
214
215impl ::aws_smithy_runtime_api::client::interceptors::Intercept for LockRuleEndpointParamsInterceptor {
216    fn name(&self) -> &'static str {
217        "LockRuleEndpointParamsInterceptor"
218    }
219
220    fn read_before_execution(
221        &self,
222        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
223            '_,
224            ::aws_smithy_runtime_api::client::interceptors::context::Input,
225            ::aws_smithy_runtime_api::client::interceptors::context::Output,
226            ::aws_smithy_runtime_api::client::interceptors::context::Error,
227        >,
228        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
229    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
230        let _input = context
231            .input()
232            .downcast_ref::<LockRuleInput>()
233            .ok_or("failed to downcast to LockRuleInput")?;
234
235        let params = crate::config::endpoint::Params::builder()
236            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
237            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
238            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
239            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
240            .build()
241            .map_err(|err| {
242                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
243            })?;
244        cfg.interceptor_state()
245            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
246        ::std::result::Result::Ok(())
247    }
248}
249
250// The get_* functions below are generated from JMESPath expressions in the
251// operationContextParams trait. They target the operation's input shape.
252
253/// Error type for the `LockRuleError` operation.
254#[non_exhaustive]
255#[derive(::std::fmt::Debug)]
256pub enum LockRuleError {
257    /// <p>The specified retention rule lock request can't be completed.</p>
258    ConflictException(crate::types::error::ConflictException),
259    /// <p>The service could not respond to the request due to an internal problem.</p>
260    InternalServerException(crate::types::error::InternalServerException),
261    /// <p>The specified resource was not found.</p>
262    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
263    /// <p>One or more of the parameters in the request is not valid.</p>
264    ValidationException(crate::types::error::ValidationException),
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-LockRuleError) for what information is available for the error.")]
272    Unhandled(crate::error::sealed_unhandled::Unhandled),
273}
274impl LockRuleError {
275    /// Creates the `LockRuleError::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 `LockRuleError::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::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
299            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
300            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
301            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
302            Self::Unhandled(e) => &e.meta,
303        }
304    }
305    /// Returns `true` if the error kind is `LockRuleError::ConflictException`.
306    pub fn is_conflict_exception(&self) -> bool {
307        matches!(self, Self::ConflictException(_))
308    }
309    /// Returns `true` if the error kind is `LockRuleError::InternalServerException`.
310    pub fn is_internal_server_exception(&self) -> bool {
311        matches!(self, Self::InternalServerException(_))
312    }
313    /// Returns `true` if the error kind is `LockRuleError::ResourceNotFoundException`.
314    pub fn is_resource_not_found_exception(&self) -> bool {
315        matches!(self, Self::ResourceNotFoundException(_))
316    }
317    /// Returns `true` if the error kind is `LockRuleError::ValidationException`.
318    pub fn is_validation_exception(&self) -> bool {
319        matches!(self, Self::ValidationException(_))
320    }
321}
322impl ::std::error::Error for LockRuleError {
323    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
324        match self {
325            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
326            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
327            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
328            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
329            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
330        }
331    }
332}
333impl ::std::fmt::Display for LockRuleError {
334    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
335        match self {
336            Self::ConflictException(_inner) => _inner.fmt(f),
337            Self::InternalServerException(_inner) => _inner.fmt(f),
338            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
339            Self::ValidationException(_inner) => _inner.fmt(f),
340            Self::Unhandled(_inner) => {
341                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
342                    write!(f, "unhandled error ({code})")
343                } else {
344                    f.write_str("unhandled error")
345                }
346            }
347        }
348    }
349}
350impl ::aws_smithy_types::retry::ProvideErrorKind for LockRuleError {
351    fn code(&self) -> ::std::option::Option<&str> {
352        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
353    }
354    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
355        ::std::option::Option::None
356    }
357}
358impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for LockRuleError {
359    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
360        match self {
361            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
362            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
363            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
364            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
365            Self::Unhandled(_inner) => &_inner.meta,
366        }
367    }
368}
369impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for LockRuleError {
370    fn create_unhandled_error(
371        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
372        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
373    ) -> Self {
374        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
375            source,
376            meta: meta.unwrap_or_default(),
377        })
378    }
379}
380impl ::aws_types::request_id::RequestId for crate::operation::lock_rule::LockRuleError {
381    fn request_id(&self) -> Option<&str> {
382        self.meta().request_id()
383    }
384}
385
386pub use crate::operation::lock_rule::_lock_rule_output::LockRuleOutput;
387
388pub use crate::operation::lock_rule::_lock_rule_input::LockRuleInput;
389
390mod _lock_rule_input;
391
392mod _lock_rule_output;
393
394/// Builders
395pub mod builders;
aws_sdk_rbin/operation/lock_rule.rs

aws_sdk_rbin/operation/
lock_rule.rs
