aws_sdk_backup/operation/
list_legal_holds.rs

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

aws_sdk_backup/operation/
list_legal_holds.rs
