aws_sdk_backup/operation/
describe_framework.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeFramework`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeFramework;
6impl DescribeFramework {
7    /// Creates a new `DescribeFramework`
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::describe_framework::DescribeFrameworkInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_framework::DescribeFrameworkOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_framework::DescribeFrameworkError,
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::describe_framework::DescribeFrameworkError>()
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::describe_framework::DescribeFrameworkOutput>()
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::describe_framework::DescribeFrameworkInput,
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", "DescribeFramework", 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.DescribeFramework",
59                "rpc.service" = "Backup",
60                "rpc.method" = "DescribeFramework",
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 DescribeFramework {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeFramework");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeFrameworkRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeFrameworkResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeFramework")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "DescribeFramework",
107            "Backup",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeFramework")
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                DescribeFrameworkTelemetryInputCaptureInterceptor,
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
134            ))
135            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
136                DescribeFrameworkEndpointParamsInterceptor,
137            ))
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
139                crate::operation::describe_framework::DescribeFrameworkError,
140            >::new())
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142                crate::operation::describe_framework::DescribeFrameworkError,
143            >::new())
144            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
145                crate::operation::describe_framework::DescribeFrameworkError,
146            >::new());
147
148        ::std::borrow::Cow::Owned(rcb)
149    }
150}
151
152#[derive(Debug)]
153struct DescribeFrameworkTelemetryInputCaptureInterceptor;
154
155#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
156impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeFrameworkTelemetryInputCaptureInterceptor {
157    fn name(&self) -> &'static str {
158        "DescribeFrameworkTelemetryInputCaptureInterceptor"
159    }
160
161    fn read_before_execution(
162        &self,
163        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
164            '_,
165            ::aws_smithy_runtime_api::client::interceptors::context::Input,
166            ::aws_smithy_runtime_api::client::interceptors::context::Output,
167            ::aws_smithy_runtime_api::client::interceptors::context::Error,
168        >,
169        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
171        // Nothing to do unless the customer opted in by naming members to record.
172        let ::std::option::Option::Some(requested) = cfg
173            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
174            .filter(|r| !r.is_empty())
175        else {
176            return ::std::result::Result::Ok(());
177        };
178
179        let ::std::option::Option::Some(input) = context.input().downcast_ref::<DescribeFrameworkInput>() else {
180            // A mismatched input is not this interceptor's concern; skip quietly.
181            return ::std::result::Result::Ok(());
182        };
183
184        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
185        if requested.should_capture("FrameworkName") {
186            if let ::std::option::Option::Some(value) = input.framework_name.as_deref() {
187                captured.insert("FrameworkName", value);
188            }
189        }
190
191        cfg.interceptor_state().store_put(captured);
192        ::std::result::Result::Ok(())
193    }
194}
195#[derive(Debug)]
196struct DescribeFrameworkResponseDeserializer;
197impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeFrameworkResponseDeserializer {
198    fn deserialize_nonstreaming_with_config(
199        &self,
200        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
201        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
202    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
203        let (success, status) = (response.status().is_success(), response.status().as_u16());
204        let headers = response.headers();
205        let body = response.body().bytes().expect("body loaded");
206        #[allow(unused_mut)]
207        let mut force_error = false;
208        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
209        let parse_result = if !success && status != 200 || force_error {
210            crate::protocol_serde::shape_describe_framework::de_describe_framework_http_error(status, headers, body)
211        } else {
212            crate::protocol_serde::shape_describe_framework::de_describe_framework_http_response(status, headers, body)
213        };
214        crate::protocol_serde::type_erase_result(parse_result)
215    }
216}
217#[derive(Debug)]
218struct DescribeFrameworkRequestSerializer;
219impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeFrameworkRequestSerializer {
220    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
221    fn serialize_input(
222        &self,
223        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
224        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
225    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
226        let input = input
227            .downcast::<crate::operation::describe_framework::DescribeFrameworkInput>()
228            .expect("correct type");
229        let _header_serialization_settings = _cfg
230            .load::<crate::serialization_settings::HeaderSerializationSettings>()
231            .cloned()
232            .unwrap_or_default();
233        let mut request_builder = {
234            #[allow(clippy::uninlined_format_args)]
235            fn uri_base(
236                _input: &crate::operation::describe_framework::DescribeFrameworkInput,
237                output: &mut ::std::string::String,
238            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
239                use ::std::fmt::Write as _;
240                let input_1 = &_input.framework_name;
241                let input_1 = input_1
242                    .as_ref()
243                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("framework_name", "cannot be empty or unset"))?;
244                let framework_name = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
245                if framework_name.is_empty() {
246                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
247                        "framework_name",
248                        "cannot be empty or unset",
249                    ));
250                }
251                ::std::write!(output, "/audit/frameworks/{FrameworkName}", FrameworkName = framework_name).expect("formatting should succeed");
252                ::std::result::Result::Ok(())
253            }
254            #[allow(clippy::unnecessary_wraps)]
255            fn update_http_builder(
256                input: &crate::operation::describe_framework::DescribeFrameworkInput,
257                builder: ::http_1x::request::Builder,
258            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
259                let mut uri = ::std::string::String::new();
260                uri_base(input, &mut uri)?;
261                ::std::result::Result::Ok(builder.method("GET").uri(uri))
262            }
263            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
264            builder
265        };
266        let body = ::aws_smithy_types::body::SdkBody::from("");
267
268        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
269    }
270}
271#[derive(Debug)]
272struct DescribeFrameworkEndpointParamsInterceptor;
273
274#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
275impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeFrameworkEndpointParamsInterceptor {
276    fn name(&self) -> &'static str {
277        "DescribeFrameworkEndpointParamsInterceptor"
278    }
279
280    fn read_before_execution(
281        &self,
282        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
283            '_,
284            ::aws_smithy_runtime_api::client::interceptors::context::Input,
285            ::aws_smithy_runtime_api::client::interceptors::context::Output,
286            ::aws_smithy_runtime_api::client::interceptors::context::Error,
287        >,
288        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
289    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
290        let _input = context
291            .input()
292            .downcast_ref::<DescribeFrameworkInput>()
293            .ok_or("failed to downcast to DescribeFrameworkInput")?;
294
295        let params = crate::config::endpoint::Params::builder()
296            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
297            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
298            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
299            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
300            .build()
301            .map_err(|err| {
302                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
303            })?;
304        cfg.interceptor_state()
305            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
306        ::std::result::Result::Ok(())
307    }
308}
309
310// The get_* functions below are generated from JMESPath expressions in the
311// operationContextParams trait. They target the operation's input shape.
312
313/// Error type for the `DescribeFrameworkError` operation.
314#[non_exhaustive]
315#[derive(::std::fmt::Debug)]
316pub enum DescribeFrameworkError {
317    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
318    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
319    /// <p>Indicates that a required parameter is missing.</p>
320    MissingParameterValueException(crate::types::error::MissingParameterValueException),
321    /// <p>A resource that is required for the action doesn't exist.</p>
322    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
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-DescribeFrameworkError) for what information is available for the error.")]
332    Unhandled(crate::error::sealed_unhandled::Unhandled),
333}
334impl DescribeFrameworkError {
335    /// Creates the `DescribeFrameworkError::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 `DescribeFrameworkError::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::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
360            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
361            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
362            Self::Unhandled(e) => &e.meta,
363        }
364    }
365    /// Returns `true` if the error kind is `DescribeFrameworkError::InvalidParameterValueException`.
366    pub fn is_invalid_parameter_value_exception(&self) -> bool {
367        matches!(self, Self::InvalidParameterValueException(_))
368    }
369    /// Returns `true` if the error kind is `DescribeFrameworkError::MissingParameterValueException`.
370    pub fn is_missing_parameter_value_exception(&self) -> bool {
371        matches!(self, Self::MissingParameterValueException(_))
372    }
373    /// Returns `true` if the error kind is `DescribeFrameworkError::ResourceNotFoundException`.
374    pub fn is_resource_not_found_exception(&self) -> bool {
375        matches!(self, Self::ResourceNotFoundException(_))
376    }
377    /// Returns `true` if the error kind is `DescribeFrameworkError::ServiceUnavailableException`.
378    pub fn is_service_unavailable_exception(&self) -> bool {
379        matches!(self, Self::ServiceUnavailableException(_))
380    }
381}
382impl ::std::error::Error for DescribeFrameworkError {
383    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
384        match self {
385            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
386            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
387            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
388            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
389            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
390        }
391    }
392}
393impl ::std::fmt::Display for DescribeFrameworkError {
394    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
395        match self {
396            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
397            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
398            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
399            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
400            Self::Unhandled(_inner) => {
401                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
402                    write!(f, "unhandled error ({code})")
403                } else {
404                    f.write_str("unhandled error")
405                }
406            }
407        }
408    }
409}
410impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeFrameworkError {
411    fn code(&self) -> ::std::option::Option<&str> {
412        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
413    }
414    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
415        ::std::option::Option::None
416    }
417}
418impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeFrameworkError {
419    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
420        match self {
421            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
422            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
423            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
424            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
425            Self::Unhandled(_inner) => &_inner.meta,
426        }
427    }
428}
429impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeFrameworkError {
430    fn create_unhandled_error(
431        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
432        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
433    ) -> Self {
434        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
435            source,
436            meta: meta.unwrap_or_default(),
437        })
438    }
439}
440impl ::aws_types::request_id::RequestId for crate::operation::describe_framework::DescribeFrameworkError {
441    fn request_id(&self) -> Option<&str> {
442        self.meta().request_id()
443    }
444}
445
446pub use crate::operation::describe_framework::_describe_framework_input::DescribeFrameworkInput;
447
448pub use crate::operation::describe_framework::_describe_framework_output::DescribeFrameworkOutput;
449
450mod _describe_framework_input;
451
452mod _describe_framework_output;
453
454/// Builders
455pub mod builders;
aws_sdk_backup/operation/describe_framework.rs

aws_sdk_backup/operation/
describe_framework.rs
