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