aws_sdk_backup/operation/
start_scan_job.rs1#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartScanJob;
6impl StartScanJob {
7 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 .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 StartScanJobTelemetryInputCaptureInterceptor,
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 StartScanJobEndpointParamsInterceptor,
134 ))
135 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136 crate::operation::start_scan_job::StartScanJobError,
137 >::new())
138 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139 crate::operation::start_scan_job::StartScanJobError,
140 >::new())
141 .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
142 crate::operation::start_scan_job::StartScanJobError,
143 >::new())
144 .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
145 crate::operation::start_scan_job::StartScanJobError,
146 >::new());
147
148 ::std::borrow::Cow::Owned(rcb)
149 }
150}
151
152#[derive(Debug)]
153struct StartScanJobTelemetryInputCaptureInterceptor;
154
155#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
156impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartScanJobTelemetryInputCaptureInterceptor {
157 fn name(&self) -> &'static str {
158 "StartScanJobTelemetryInputCaptureInterceptor"
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 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::<StartScanJobInput>() else {
180 return ::std::result::Result::Ok(());
182 };
183
184 let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
185 if requested.should_capture("BackupVaultName") {
186 if let ::std::option::Option::Some(value) = input.backup_vault_name.as_deref() {
187 captured.insert("BackupVaultName", value);
188 }
189 }
190 if requested.should_capture("IamRoleArn") {
191 if let ::std::option::Option::Some(value) = input.iam_role_arn.as_deref() {
192 captured.insert("IamRoleArn", value);
193 }
194 }
195 if requested.should_capture("IdempotencyToken") {
196 if let ::std::option::Option::Some(value) = input.idempotency_token.as_deref() {
197 captured.insert("IdempotencyToken", value);
198 }
199 }
200 if requested.should_capture("RecoveryPointArn") {
201 if let ::std::option::Option::Some(value) = input.recovery_point_arn.as_deref() {
202 captured.insert("RecoveryPointArn", value);
203 }
204 }
205 if requested.should_capture("ScanBaseRecoveryPointArn") {
206 if let ::std::option::Option::Some(value) = input.scan_base_recovery_point_arn.as_deref() {
207 captured.insert("ScanBaseRecoveryPointArn", value);
208 }
209 }
210 if requested.should_capture("ScannerRoleArn") {
211 if let ::std::option::Option::Some(value) = input.scanner_role_arn.as_deref() {
212 captured.insert("ScannerRoleArn", value);
213 }
214 }
215
216 cfg.interceptor_state().store_put(captured);
217 ::std::result::Result::Ok(())
218 }
219}
220#[derive(Debug)]
221struct StartScanJobResponseDeserializer;
222impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartScanJobResponseDeserializer {
223 fn deserialize_nonstreaming_with_config(
224 &self,
225 response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
226 _cfg: &::aws_smithy_types::config_bag::ConfigBag,
227 ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
228 let (success, status) = (response.status().is_success(), response.status().as_u16());
229 let headers = response.headers();
230 let body = response.body().bytes().expect("body loaded");
231 #[allow(unused_mut)]
232 let mut force_error = false;
233 ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
234 let parse_result = if !success && status != 201 || force_error {
235 crate::protocol_serde::shape_start_scan_job::de_start_scan_job_http_error(status, headers, body)
236 } else {
237 crate::protocol_serde::shape_start_scan_job::de_start_scan_job_http_response(status, headers, body)
238 };
239 crate::protocol_serde::type_erase_result(parse_result)
240 }
241}
242#[derive(Debug)]
243struct StartScanJobRequestSerializer;
244impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartScanJobRequestSerializer {
245 #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
246 fn serialize_input(
247 &self,
248 input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
249 _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
250 ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
251 let input = input
252 .downcast::<crate::operation::start_scan_job::StartScanJobInput>()
253 .expect("correct type");
254 let _header_serialization_settings = _cfg
255 .load::<crate::serialization_settings::HeaderSerializationSettings>()
256 .cloned()
257 .unwrap_or_default();
258 let mut request_builder = {
259 #[allow(clippy::uninlined_format_args)]
260 fn uri_base(
261 _input: &crate::operation::start_scan_job::StartScanJobInput,
262 output: &mut ::std::string::String,
263 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
264 use ::std::fmt::Write as _;
265 ::std::write!(output, "/scan/job").expect("formatting should succeed");
266 ::std::result::Result::Ok(())
267 }
268 #[allow(clippy::unnecessary_wraps)]
269 fn update_http_builder(
270 input: &crate::operation::start_scan_job::StartScanJobInput,
271 builder: ::http_1x::request::Builder,
272 ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
273 let mut uri = ::std::string::String::new();
274 uri_base(input, &mut uri)?;
275 ::std::result::Result::Ok(builder.method("PUT").uri(uri))
276 }
277 let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
278 builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/json");
279 builder
280 };
281 let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_start_scan_job::ser_start_scan_job_input(&input)?);
282 if let Some(content_length) = body.content_length() {
283 let content_length = content_length.to_string();
284 request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
285 }
286 ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
287 }
288}
289#[derive(Debug)]
290struct StartScanJobEndpointParamsInterceptor;
291
292#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
293impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartScanJobEndpointParamsInterceptor {
294 fn name(&self) -> &'static str {
295 "StartScanJobEndpointParamsInterceptor"
296 }
297
298 fn read_before_execution(
299 &self,
300 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
301 '_,
302 ::aws_smithy_runtime_api::client::interceptors::context::Input,
303 ::aws_smithy_runtime_api::client::interceptors::context::Output,
304 ::aws_smithy_runtime_api::client::interceptors::context::Error,
305 >,
306 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
307 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
308 let _input = context
309 .input()
310 .downcast_ref::<StartScanJobInput>()
311 .ok_or("failed to downcast to StartScanJobInput")?;
312
313 let params = crate::config::endpoint::Params::builder()
314 .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
315 .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
316 .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
317 .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
318 .build()
319 .map_err(|err| {
320 ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
321 })?;
322 cfg.interceptor_state()
323 .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
324 ::std::result::Result::Ok(())
325 }
326}
327
328#[non_exhaustive]
333#[derive(::std::fmt::Debug)]
334pub enum StartScanJobError {
335 InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
337 InvalidRequestException(crate::types::error::InvalidRequestException),
339 LimitExceededException(crate::types::error::LimitExceededException),
341 MissingParameterValueException(crate::types::error::MissingParameterValueException),
343 ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
345 ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
347 #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
349 variable wildcard pattern and check `.code()`:
350 \
351 `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
352 \
353 See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartScanJobError) for what information is available for the error.")]
354 Unhandled(crate::error::sealed_unhandled::Unhandled),
355}
356impl StartScanJobError {
357 pub fn unhandled(
359 err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
360 ) -> Self {
361 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
362 source: err.into(),
363 meta: ::std::default::Default::default(),
364 })
365 }
366
367 pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
369 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
370 source: err.clone().into(),
371 meta: err,
372 })
373 }
374 pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
379 match self {
380 Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
381 Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
382 Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
383 Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
384 Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
385 Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
386 Self::Unhandled(e) => &e.meta,
387 }
388 }
389 pub fn is_invalid_parameter_value_exception(&self) -> bool {
391 matches!(self, Self::InvalidParameterValueException(_))
392 }
393 pub fn is_invalid_request_exception(&self) -> bool {
395 matches!(self, Self::InvalidRequestException(_))
396 }
397 pub fn is_limit_exceeded_exception(&self) -> bool {
399 matches!(self, Self::LimitExceededException(_))
400 }
401 pub fn is_missing_parameter_value_exception(&self) -> bool {
403 matches!(self, Self::MissingParameterValueException(_))
404 }
405 pub fn is_resource_not_found_exception(&self) -> bool {
407 matches!(self, Self::ResourceNotFoundException(_))
408 }
409 pub fn is_service_unavailable_exception(&self) -> bool {
411 matches!(self, Self::ServiceUnavailableException(_))
412 }
413}
414impl ::std::error::Error for StartScanJobError {
415 fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
416 match self {
417 Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
418 Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
419 Self::LimitExceededException(_inner) => ::std::option::Option::Some(_inner),
420 Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
421 Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
422 Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
423 Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
424 }
425 }
426}
427impl ::std::fmt::Display for StartScanJobError {
428 fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
429 match self {
430 Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
431 Self::InvalidRequestException(_inner) => _inner.fmt(f),
432 Self::LimitExceededException(_inner) => _inner.fmt(f),
433 Self::MissingParameterValueException(_inner) => _inner.fmt(f),
434 Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
435 Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
436 Self::Unhandled(_inner) => {
437 if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
438 write!(f, "unhandled error ({code})")
439 } else {
440 f.write_str("unhandled error")
441 }
442 }
443 }
444 }
445}
446impl ::aws_smithy_types::retry::ProvideErrorKind for StartScanJobError {
447 fn code(&self) -> ::std::option::Option<&str> {
448 ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
449 }
450 fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
451 ::std::option::Option::None
452 }
453}
454impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartScanJobError {
455 fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
456 match self {
457 Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
458 Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
459 Self::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
460 Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
461 Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
462 Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
463 Self::Unhandled(_inner) => &_inner.meta,
464 }
465 }
466}
467impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartScanJobError {
468 fn create_unhandled_error(
469 source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
470 meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
471 ) -> Self {
472 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
473 source,
474 meta: meta.unwrap_or_default(),
475 })
476 }
477}
478impl ::aws_types::request_id::RequestId for crate::operation::start_scan_job::StartScanJobError {
479 fn request_id(&self) -> Option<&str> {
480 self.meta().request_id()
481 }
482}
483
484pub use crate::operation::start_scan_job::_start_scan_job_input::StartScanJobInput;
485
486pub use crate::operation::start_scan_job::_start_scan_job_output::StartScanJobOutput;
487
488mod _start_scan_job_input;
489
490mod _start_scan_job_output;
491
492pub mod builders;