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

aws_sdk_rbin/operation/
lock_rule.rs
