aws_sdk_backup/operation/
describe_scan_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeScanJob`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeScanJob;
6impl DescribeScanJob {
7    /// Creates a new `DescribeScanJob`
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_scan_job::DescribeScanJobInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_scan_job::DescribeScanJobOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_scan_job::DescribeScanJobError,
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_scan_job::DescribeScanJobError>()
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_scan_job::DescribeScanJobOutput>()
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_scan_job::DescribeScanJobInput,
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", "DescribeScanJob", 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.DescribeScanJob",
59                "rpc.service" = "Backup",
60                "rpc.method" = "DescribeScanJob",
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 DescribeScanJob {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeScanJob");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeScanJobRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeScanJobResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeScanJob")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("DescribeScanJob", "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("DescribeScanJob")
126            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
127                DescribeScanJobTelemetryInputCaptureInterceptor,
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                DescribeScanJobEndpointParamsInterceptor,
134            ))
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136                crate::operation::describe_scan_job::DescribeScanJobError,
137            >::new())
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139                crate::operation::describe_scan_job::DescribeScanJobError,
140            >::new())
141            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
142                crate::operation::describe_scan_job::DescribeScanJobError,
143            >::new());
144
145        ::std::borrow::Cow::Owned(rcb)
146    }
147}
148
149#[derive(Debug)]
150struct DescribeScanJobTelemetryInputCaptureInterceptor;
151
152#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
153impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeScanJobTelemetryInputCaptureInterceptor {
154    fn name(&self) -> &'static str {
155        "DescribeScanJobTelemetryInputCaptureInterceptor"
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::<DescribeScanJobInput>() 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("ScanJobId") {
183            if let ::std::option::Option::Some(value) = input.scan_job_id.as_deref() {
184                captured.insert("ScanJobId", value);
185            }
186        }
187
188        cfg.interceptor_state().store_put(captured);
189        ::std::result::Result::Ok(())
190    }
191}
192#[derive(Debug)]
193struct DescribeScanJobResponseDeserializer;
194impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeScanJobResponseDeserializer {
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_describe_scan_job::de_describe_scan_job_http_error(status, headers, body)
208        } else {
209            crate::protocol_serde::shape_describe_scan_job::de_describe_scan_job_http_response(status, headers, body)
210        };
211        crate::protocol_serde::type_erase_result(parse_result)
212    }
213}
214#[derive(Debug)]
215struct DescribeScanJobRequestSerializer;
216impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeScanJobRequestSerializer {
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::describe_scan_job::DescribeScanJobInput>()
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::describe_scan_job::DescribeScanJobInput,
234                output: &mut ::std::string::String,
235            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
236                use ::std::fmt::Write as _;
237                let input_1 = &_input.scan_job_id;
238                let input_1 = input_1
239                    .as_ref()
240                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("scan_job_id", "cannot be empty or unset"))?;
241                let scan_job_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
242                if scan_job_id.is_empty() {
243                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
244                        "scan_job_id",
245                        "cannot be empty or unset",
246                    ));
247                }
248                ::std::write!(output, "/scan/jobs/{ScanJobId}", ScanJobId = scan_job_id).expect("formatting should succeed");
249                ::std::result::Result::Ok(())
250            }
251            #[allow(clippy::unnecessary_wraps)]
252            fn update_http_builder(
253                input: &crate::operation::describe_scan_job::DescribeScanJobInput,
254                builder: ::http_1x::request::Builder,
255            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
256                let mut uri = ::std::string::String::new();
257                uri_base(input, &mut uri)?;
258                ::std::result::Result::Ok(builder.method("GET").uri(uri))
259            }
260            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
261            builder
262        };
263        let body = ::aws_smithy_types::body::SdkBody::from("");
264
265        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
266    }
267}
268#[derive(Debug)]
269struct DescribeScanJobEndpointParamsInterceptor;
270
271#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
272impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeScanJobEndpointParamsInterceptor {
273    fn name(&self) -> &'static str {
274        "DescribeScanJobEndpointParamsInterceptor"
275    }
276
277    fn read_before_execution(
278        &self,
279        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
280            '_,
281            ::aws_smithy_runtime_api::client::interceptors::context::Input,
282            ::aws_smithy_runtime_api::client::interceptors::context::Output,
283            ::aws_smithy_runtime_api::client::interceptors::context::Error,
284        >,
285        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
286    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
287        let _input = context
288            .input()
289            .downcast_ref::<DescribeScanJobInput>()
290            .ok_or("failed to downcast to DescribeScanJobInput")?;
291
292        let params = crate::config::endpoint::Params::builder()
293            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
294            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
295            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
296            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
297            .build()
298            .map_err(|err| {
299                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
300            })?;
301        cfg.interceptor_state()
302            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
303        ::std::result::Result::Ok(())
304    }
305}
306
307// The get_* functions below are generated from JMESPath expressions in the
308// operationContextParams trait. They target the operation's input shape.
309
310/// Error type for the `DescribeScanJobError` operation.
311#[non_exhaustive]
312#[derive(::std::fmt::Debug)]
313pub enum DescribeScanJobError {
314    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
315    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
316    /// <p>Indicates that a required parameter is missing.</p>
317    MissingParameterValueException(crate::types::error::MissingParameterValueException),
318    /// <p>A resource that is required for the action doesn't exist.</p>
319    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
320    /// <p>The request failed due to a temporary failure of the server.</p>
321    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
322    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
323    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
324    variable wildcard pattern and check `.code()`:
325     \
326    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
327     \
328    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeScanJobError) for what information is available for the error.")]
329    Unhandled(crate::error::sealed_unhandled::Unhandled),
330}
331impl DescribeScanJobError {
332    /// Creates the `DescribeScanJobError::Unhandled` variant from any error type.
333    pub fn unhandled(
334        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
335    ) -> Self {
336        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
337            source: err.into(),
338            meta: ::std::default::Default::default(),
339        })
340    }
341
342    /// Creates the `DescribeScanJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
343    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
344        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
345            source: err.clone().into(),
346            meta: err,
347        })
348    }
349    ///
350    /// Returns error metadata, which includes the error code, message,
351    /// request ID, and potentially additional information.
352    ///
353    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
354        match self {
355            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
356            Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
357            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
358            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
359            Self::Unhandled(e) => &e.meta,
360        }
361    }
362    /// Returns `true` if the error kind is `DescribeScanJobError::InvalidParameterValueException`.
363    pub fn is_invalid_parameter_value_exception(&self) -> bool {
364        matches!(self, Self::InvalidParameterValueException(_))
365    }
366    /// Returns `true` if the error kind is `DescribeScanJobError::MissingParameterValueException`.
367    pub fn is_missing_parameter_value_exception(&self) -> bool {
368        matches!(self, Self::MissingParameterValueException(_))
369    }
370    /// Returns `true` if the error kind is `DescribeScanJobError::ResourceNotFoundException`.
371    pub fn is_resource_not_found_exception(&self) -> bool {
372        matches!(self, Self::ResourceNotFoundException(_))
373    }
374    /// Returns `true` if the error kind is `DescribeScanJobError::ServiceUnavailableException`.
375    pub fn is_service_unavailable_exception(&self) -> bool {
376        matches!(self, Self::ServiceUnavailableException(_))
377    }
378}
379impl ::std::error::Error for DescribeScanJobError {
380    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
381        match self {
382            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
383            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
384            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
385            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
386            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
387        }
388    }
389}
390impl ::std::fmt::Display for DescribeScanJobError {
391    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
392        match self {
393            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
394            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
395            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
396            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
397            Self::Unhandled(_inner) => {
398                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
399                    write!(f, "unhandled error ({code})")
400                } else {
401                    f.write_str("unhandled error")
402                }
403            }
404        }
405    }
406}
407impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeScanJobError {
408    fn code(&self) -> ::std::option::Option<&str> {
409        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
410    }
411    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
412        ::std::option::Option::None
413    }
414}
415impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeScanJobError {
416    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
417        match self {
418            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
419            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
420            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
421            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
422            Self::Unhandled(_inner) => &_inner.meta,
423        }
424    }
425}
426impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeScanJobError {
427    fn create_unhandled_error(
428        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
429        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
430    ) -> Self {
431        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
432            source,
433            meta: meta.unwrap_or_default(),
434        })
435    }
436}
437impl ::aws_types::request_id::RequestId for crate::operation::describe_scan_job::DescribeScanJobError {
438    fn request_id(&self) -> Option<&str> {
439        self.meta().request_id()
440    }
441}
442
443pub use crate::operation::describe_scan_job::_describe_scan_job_input::DescribeScanJobInput;
444
445pub use crate::operation::describe_scan_job::_describe_scan_job_output::DescribeScanJobOutput;
446
447mod _describe_scan_job_input;
448
449mod _describe_scan_job_output;
450
451/// Builders
452pub mod builders;
aws_sdk_backup/operation/describe_scan_job.rs

aws_sdk_backup/operation/
describe_scan_job.rs
