aws_sdk_backup/operation/
start_scan_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StartScanJob`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartScanJob;
6impl StartScanJob {
7    /// Creates a new `StartScanJob`
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::start_scan_job::StartScanJobInput,
14    ) -> ::std::result::Result<
15        crate::operation::start_scan_job::StartScanJobOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::start_scan_job::StartScanJobError,
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::start_scan_job::StartScanJobError>()
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::start_scan_job::StartScanJobOutput>()
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::start_scan_job::StartScanJobInput,
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", "StartScanJob", 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.StartScanJob",
59                "rpc.service" = "Backup",
60                "rpc.method" = "StartScanJob",
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 StartScanJob {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StartScanJob");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            StartScanJobRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            StartScanJobResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("StartScanJob")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("StartScanJob", "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("StartScanJob")
126            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
127                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
128            ))
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                StartScanJobEndpointParamsInterceptor,
131            ))
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::start_scan_job::StartScanJobError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::start_scan_job::StartScanJobError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::start_scan_job::StartScanJobError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct StartScanJobResponseDeserializer;
148impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartScanJobResponseDeserializer {
149    fn deserialize_nonstreaming(
150        &self,
151        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
152    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
153        let (success, status) = (response.status().is_success(), response.status().as_u16());
154        let headers = response.headers();
155        let body = response.body().bytes().expect("body loaded");
156        #[allow(unused_mut)]
157        let mut force_error = false;
158        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
159        let parse_result = if !success && status != 201 || force_error {
160            crate::protocol_serde::shape_start_scan_job::de_start_scan_job_http_error(status, headers, body)
161        } else {
162            crate::protocol_serde::shape_start_scan_job::de_start_scan_job_http_response(status, headers, body)
163        };
164        crate::protocol_serde::type_erase_result(parse_result)
165    }
166}
167#[derive(Debug)]
168struct StartScanJobRequestSerializer;
169impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartScanJobRequestSerializer {
170    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
171    fn serialize_input(
172        &self,
173        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
174        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
175    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
176        let input = input
177            .downcast::<crate::operation::start_scan_job::StartScanJobInput>()
178            .expect("correct type");
179        let _header_serialization_settings = _cfg
180            .load::<crate::serialization_settings::HeaderSerializationSettings>()
181            .cloned()
182            .unwrap_or_default();
183        let mut request_builder = {
184            #[allow(clippy::uninlined_format_args)]
185            fn uri_base(
186                _input: &crate::operation::start_scan_job::StartScanJobInput,
187                output: &mut ::std::string::String,
188            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
189                use ::std::fmt::Write as _;
190                ::std::write!(output, "/scan/job").expect("formatting should succeed");
191                ::std::result::Result::Ok(())
192            }
193            #[allow(clippy::unnecessary_wraps)]
194            fn update_http_builder(
195                input: &crate::operation::start_scan_job::StartScanJobInput,
196                builder: ::http_1x::request::Builder,
197            ) -> ::std::result::Result<::http_1x::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("PUT").uri(uri))
201            }
202            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
203            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/json");
204            builder
205        };
206        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_start_scan_job::ser_start_scan_job_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_1x::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 StartScanJobEndpointParamsInterceptor;
216
217#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
218impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartScanJobEndpointParamsInterceptor {
219    fn name(&self) -> &'static str {
220        "StartScanJobEndpointParamsInterceptor"
221    }
222
223    fn read_before_execution(
224        &self,
225        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
226            '_,
227            ::aws_smithy_runtime_api::client::interceptors::context::Input,
228            ::aws_smithy_runtime_api::client::interceptors::context::Output,
229            ::aws_smithy_runtime_api::client::interceptors::context::Error,
230        >,
231        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
232    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
233        let _input = context
234            .input()
235            .downcast_ref::<StartScanJobInput>()
236            .ok_or("failed to downcast to StartScanJobInput")?;
237
238        let params = crate::config::endpoint::Params::builder()
239            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
240            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
241            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
242            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
243            .build()
244            .map_err(|err| {
245                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
246            })?;
247        cfg.interceptor_state()
248            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
249        ::std::result::Result::Ok(())
250    }
251}
252
253// The get_* functions below are generated from JMESPath expressions in the
254// operationContextParams trait. They target the operation's input shape.
255
256/// Error type for the `StartScanJobError` operation.
257#[non_exhaustive]
258#[derive(::std::fmt::Debug)]
259pub enum StartScanJobError {
260    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
261    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
262    /// <p>Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.</p>
263    InvalidRequestException(crate::types::error::InvalidRequestException),
264    /// <p>A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.</p>
265    LimitExceededException(crate::types::error::LimitExceededException),
266    /// <p>Indicates that a required parameter is missing.</p>
267    MissingParameterValueException(crate::types::error::MissingParameterValueException),
268    /// <p>A resource that is required for the action doesn't exist.</p>
269    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
270    /// <p>The request failed due to a temporary failure of the server.</p>
271    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
272    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
273    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
274    variable wildcard pattern and check `.code()`:
275     \
276    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
277     \
278    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartScanJobError) for what information is available for the error.")]
279    Unhandled(crate::error::sealed_unhandled::Unhandled),
280}
281impl StartScanJobError {
282    /// Creates the `StartScanJobError::Unhandled` variant from any error type.
283    pub fn unhandled(
284        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
285    ) -> Self {
286        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
287            source: err.into(),
288            meta: ::std::default::Default::default(),
289        })
290    }
291
292    /// Creates the `StartScanJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
293    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
294        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
295            source: err.clone().into(),
296            meta: err,
297        })
298    }
299    ///
300    /// Returns error metadata, which includes the error code, message,
301    /// request ID, and potentially additional information.
302    ///
303    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
304        match self {
305            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
306            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
307            Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
308            Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
309            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
310            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
311            Self::Unhandled(e) => &e.meta,
312        }
313    }
314    /// Returns `true` if the error kind is `StartScanJobError::InvalidParameterValueException`.
315    pub fn is_invalid_parameter_value_exception(&self) -> bool {
316        matches!(self, Self::InvalidParameterValueException(_))
317    }
318    /// Returns `true` if the error kind is `StartScanJobError::InvalidRequestException`.
319    pub fn is_invalid_request_exception(&self) -> bool {
320        matches!(self, Self::InvalidRequestException(_))
321    }
322    /// Returns `true` if the error kind is `StartScanJobError::LimitExceededException`.
323    pub fn is_limit_exceeded_exception(&self) -> bool {
324        matches!(self, Self::LimitExceededException(_))
325    }
326    /// Returns `true` if the error kind is `StartScanJobError::MissingParameterValueException`.
327    pub fn is_missing_parameter_value_exception(&self) -> bool {
328        matches!(self, Self::MissingParameterValueException(_))
329    }
330    /// Returns `true` if the error kind is `StartScanJobError::ResourceNotFoundException`.
331    pub fn is_resource_not_found_exception(&self) -> bool {
332        matches!(self, Self::ResourceNotFoundException(_))
333    }
334    /// Returns `true` if the error kind is `StartScanJobError::ServiceUnavailableException`.
335    pub fn is_service_unavailable_exception(&self) -> bool {
336        matches!(self, Self::ServiceUnavailableException(_))
337    }
338}
339impl ::std::error::Error for StartScanJobError {
340    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
341        match self {
342            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
343            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
344            Self::LimitExceededException(_inner) => ::std::option::Option::Some(_inner),
345            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
346            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
347            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
348            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
349        }
350    }
351}
352impl ::std::fmt::Display for StartScanJobError {
353    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
354        match self {
355            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
356            Self::InvalidRequestException(_inner) => _inner.fmt(f),
357            Self::LimitExceededException(_inner) => _inner.fmt(f),
358            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
359            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
360            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
361            Self::Unhandled(_inner) => {
362                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
363                    write!(f, "unhandled error ({code})")
364                } else {
365                    f.write_str("unhandled error")
366                }
367            }
368        }
369    }
370}
371impl ::aws_smithy_types::retry::ProvideErrorKind for StartScanJobError {
372    fn code(&self) -> ::std::option::Option<&str> {
373        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
374    }
375    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
376        ::std::option::Option::None
377    }
378}
379impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartScanJobError {
380    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
381        match self {
382            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
383            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
384            Self::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
385            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
386            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
387            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
388            Self::Unhandled(_inner) => &_inner.meta,
389        }
390    }
391}
392impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartScanJobError {
393    fn create_unhandled_error(
394        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
395        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
396    ) -> Self {
397        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
398            source,
399            meta: meta.unwrap_or_default(),
400        })
401    }
402}
403impl ::aws_types::request_id::RequestId for crate::operation::start_scan_job::StartScanJobError {
404    fn request_id(&self) -> Option<&str> {
405        self.meta().request_id()
406    }
407}
408
409pub use crate::operation::start_scan_job::_start_scan_job_input::StartScanJobInput;
410
411pub use crate::operation::start_scan_job::_start_scan_job_output::StartScanJobOutput;
412
413mod _start_scan_job_input;
414
415mod _start_scan_job_output;
416
417/// Builders
418pub mod builders;
aws_sdk_backup/operation/start_scan_job.rs

aws_sdk_backup/operation/
start_scan_job.rs
