aws_sdk_backup/operation/
start_backup_job.rs1#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartBackupJob;
6impl StartBackupJob {
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_backup_job::StartBackupJobInput,
14 ) -> ::std::result::Result<
15 crate::operation::start_backup_job::StartBackupJobOutput,
16 ::aws_smithy_runtime_api::client::result::SdkError<
17 crate::operation::start_backup_job::StartBackupJobError,
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_backup_job::StartBackupJobError>()
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_backup_job::StartBackupJobOutput>()
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_backup_job::StartBackupJobInput,
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", "StartBackupJob", input, runtime_plugins, stop_point)
55 .instrument(::tracing::debug_span!(
58 "Backup.StartBackupJob",
59 "rpc.service" = "Backup",
60 "rpc.method" = "StartBackupJob",
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 runtime_plugins = runtime_plugins.with_operation_plugin(crate::client_idempotency_token::IdempotencyTokenRuntimePlugin::new(
74 |token_provider, input| {
75 let input: &mut crate::operation::start_backup_job::StartBackupJobInput = input.downcast_mut().expect("correct type");
76 if input.idempotency_token.is_none() {
77 input.idempotency_token = ::std::option::Option::Some(token_provider.make_idempotency_token());
78 }
79 },
80 ));
81 if let ::std::option::Option::Some(config_override) = config_override {
82 for plugin in config_override.runtime_plugins.iter().cloned() {
83 runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
84 }
85 runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
86 config_override,
87 client_config.config.clone(),
88 &client_config.runtime_components,
89 ));
90 }
91 runtime_plugins
92 }
93}
94impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for StartBackupJob {
95 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
96 let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StartBackupJob");
97
98 cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
99 StartBackupJobRequestSerializer,
100 ));
101 cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
102 StartBackupJobResponseDeserializer,
103 ));
104
105 cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
106 crate::config::auth::Params::builder()
107 .operation_name("StartBackupJob")
108 .build()
109 .expect("required fields set"),
110 ));
111
112 cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("StartBackupJob", "Backup"));
113 let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
114 signing_options.double_uri_encode = true;
115 signing_options.content_sha256_header = false;
116 signing_options.normalize_uri_path = true;
117 signing_options.payload_override = None;
118
119 cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
120 signing_options,
121 ..::std::default::Default::default()
122 });
123
124 ::std::option::Option::Some(cfg.freeze())
125 }
126
127 fn runtime_components(
128 &self,
129 _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
130 ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
131 #[allow(unused_mut)]
132 let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("StartBackupJob")
133 .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
134 StartBackupJobTelemetryInputCaptureInterceptor,
135 ))
136 .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
137 ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
138 ))
139 .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
140 StartBackupJobEndpointParamsInterceptor,
141 ))
142 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
143 crate::operation::start_backup_job::StartBackupJobError,
144 >::new())
145 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
146 crate::operation::start_backup_job::StartBackupJobError,
147 >::new())
148 .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
149 crate::operation::start_backup_job::StartBackupJobError,
150 >::new())
151 .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
152 crate::operation::start_backup_job::StartBackupJobError,
153 >::new());
154
155 ::std::borrow::Cow::Owned(rcb)
156 }
157}
158
159#[derive(Debug)]
160struct StartBackupJobTelemetryInputCaptureInterceptor;
161
162#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
163impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartBackupJobTelemetryInputCaptureInterceptor {
164 fn name(&self) -> &'static str {
165 "StartBackupJobTelemetryInputCaptureInterceptor"
166 }
167
168 fn read_before_execution(
169 &self,
170 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
171 '_,
172 ::aws_smithy_runtime_api::client::interceptors::context::Input,
173 ::aws_smithy_runtime_api::client::interceptors::context::Output,
174 ::aws_smithy_runtime_api::client::interceptors::context::Error,
175 >,
176 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
177 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
178 let ::std::option::Option::Some(requested) = cfg
180 .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
181 .filter(|r| !r.is_empty())
182 else {
183 return ::std::result::Result::Ok(());
184 };
185
186 let ::std::option::Option::Some(input) = context.input().downcast_ref::<StartBackupJobInput>() else {
187 return ::std::result::Result::Ok(());
189 };
190
191 let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
192 if requested.should_capture("BackupVaultName") {
193 if let ::std::option::Option::Some(value) = input.backup_vault_name.as_deref() {
194 captured.insert("BackupVaultName", value);
195 }
196 }
197 if requested.should_capture("LogicallyAirGappedBackupVaultArn") {
198 if let ::std::option::Option::Some(value) = input.logically_air_gapped_backup_vault_arn.as_deref() {
199 captured.insert("LogicallyAirGappedBackupVaultArn", value);
200 }
201 }
202 if requested.should_capture("ResourceArn") {
203 if let ::std::option::Option::Some(value) = input.resource_arn.as_deref() {
204 captured.insert("ResourceArn", value);
205 }
206 }
207 if requested.should_capture("IamRoleArn") {
208 if let ::std::option::Option::Some(value) = input.iam_role_arn.as_deref() {
209 captured.insert("IamRoleArn", value);
210 }
211 }
212 if requested.should_capture("IdempotencyToken") {
213 if let ::std::option::Option::Some(value) = input.idempotency_token.as_deref() {
214 captured.insert("IdempotencyToken", value);
215 }
216 }
217
218 cfg.interceptor_state().store_put(captured);
219 ::std::result::Result::Ok(())
220 }
221}
222#[derive(Debug)]
223struct StartBackupJobResponseDeserializer;
224impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartBackupJobResponseDeserializer {
225 fn deserialize_nonstreaming_with_config(
226 &self,
227 response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
228 _cfg: &::aws_smithy_types::config_bag::ConfigBag,
229 ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
230 let (success, status) = (response.status().is_success(), response.status().as_u16());
231 let headers = response.headers();
232 let body = response.body().bytes().expect("body loaded");
233 #[allow(unused_mut)]
234 let mut force_error = false;
235 ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
236 let parse_result = if !success && status != 200 || force_error {
237 crate::protocol_serde::shape_start_backup_job::de_start_backup_job_http_error(status, headers, body)
238 } else {
239 crate::protocol_serde::shape_start_backup_job::de_start_backup_job_http_response(status, headers, body)
240 };
241 crate::protocol_serde::type_erase_result(parse_result)
242 }
243}
244#[derive(Debug)]
245struct StartBackupJobRequestSerializer;
246impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartBackupJobRequestSerializer {
247 #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
248 fn serialize_input(
249 &self,
250 input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
251 _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
252 ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
253 let input = input
254 .downcast::<crate::operation::start_backup_job::StartBackupJobInput>()
255 .expect("correct type");
256 let _header_serialization_settings = _cfg
257 .load::<crate::serialization_settings::HeaderSerializationSettings>()
258 .cloned()
259 .unwrap_or_default();
260 let mut request_builder = {
261 #[allow(clippy::uninlined_format_args)]
262 fn uri_base(
263 _input: &crate::operation::start_backup_job::StartBackupJobInput,
264 output: &mut ::std::string::String,
265 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
266 use ::std::fmt::Write as _;
267 ::std::write!(output, "/backup-jobs").expect("formatting should succeed");
268 ::std::result::Result::Ok(())
269 }
270 #[allow(clippy::unnecessary_wraps)]
271 fn update_http_builder(
272 input: &crate::operation::start_backup_job::StartBackupJobInput,
273 builder: ::http_1x::request::Builder,
274 ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
275 let mut uri = ::std::string::String::new();
276 uri_base(input, &mut uri)?;
277 ::std::result::Result::Ok(builder.method("PUT").uri(uri))
278 }
279 let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
280 builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/json");
281 builder
282 };
283 let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_start_backup_job::ser_start_backup_job_input(&input)?);
284 if let Some(content_length) = body.content_length() {
285 let content_length = content_length.to_string();
286 request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
287 }
288 ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
289 }
290}
291#[derive(Debug)]
292struct StartBackupJobEndpointParamsInterceptor;
293
294#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
295impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartBackupJobEndpointParamsInterceptor {
296 fn name(&self) -> &'static str {
297 "StartBackupJobEndpointParamsInterceptor"
298 }
299
300 fn read_before_execution(
301 &self,
302 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
303 '_,
304 ::aws_smithy_runtime_api::client::interceptors::context::Input,
305 ::aws_smithy_runtime_api::client::interceptors::context::Output,
306 ::aws_smithy_runtime_api::client::interceptors::context::Error,
307 >,
308 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
309 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
310 let _input = context
311 .input()
312 .downcast_ref::<StartBackupJobInput>()
313 .ok_or("failed to downcast to StartBackupJobInput")?;
314
315 let params = crate::config::endpoint::Params::builder()
316 .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
317 .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
318 .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
319 .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
320 .build()
321 .map_err(|err| {
322 ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
323 })?;
324 cfg.interceptor_state()
325 .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
326 ::std::result::Result::Ok(())
327 }
328}
329
330#[non_exhaustive]
335#[derive(::std::fmt::Debug)]
336pub enum StartBackupJobError {
337 InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
339 InvalidRequestException(crate::types::error::InvalidRequestException),
341 LimitExceededException(crate::types::error::LimitExceededException),
343 MissingParameterValueException(crate::types::error::MissingParameterValueException),
345 ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
347 ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
349 #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
351 variable wildcard pattern and check `.code()`:
352 \
353 `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
354 \
355 See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartBackupJobError) for what information is available for the error.")]
356 Unhandled(crate::error::sealed_unhandled::Unhandled),
357}
358impl StartBackupJobError {
359 pub fn unhandled(
361 err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
362 ) -> Self {
363 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
364 source: err.into(),
365 meta: ::std::default::Default::default(),
366 })
367 }
368
369 pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
371 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
372 source: err.clone().into(),
373 meta: err,
374 })
375 }
376 pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
381 match self {
382 Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
383 Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
384 Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
385 Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
386 Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
387 Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
388 Self::Unhandled(e) => &e.meta,
389 }
390 }
391 pub fn is_invalid_parameter_value_exception(&self) -> bool {
393 matches!(self, Self::InvalidParameterValueException(_))
394 }
395 pub fn is_invalid_request_exception(&self) -> bool {
397 matches!(self, Self::InvalidRequestException(_))
398 }
399 pub fn is_limit_exceeded_exception(&self) -> bool {
401 matches!(self, Self::LimitExceededException(_))
402 }
403 pub fn is_missing_parameter_value_exception(&self) -> bool {
405 matches!(self, Self::MissingParameterValueException(_))
406 }
407 pub fn is_resource_not_found_exception(&self) -> bool {
409 matches!(self, Self::ResourceNotFoundException(_))
410 }
411 pub fn is_service_unavailable_exception(&self) -> bool {
413 matches!(self, Self::ServiceUnavailableException(_))
414 }
415}
416impl ::std::error::Error for StartBackupJobError {
417 fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
418 match self {
419 Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
420 Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
421 Self::LimitExceededException(_inner) => ::std::option::Option::Some(_inner),
422 Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
423 Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
424 Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
425 Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
426 }
427 }
428}
429impl ::std::fmt::Display for StartBackupJobError {
430 fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
431 match self {
432 Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
433 Self::InvalidRequestException(_inner) => _inner.fmt(f),
434 Self::LimitExceededException(_inner) => _inner.fmt(f),
435 Self::MissingParameterValueException(_inner) => _inner.fmt(f),
436 Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
437 Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
438 Self::Unhandled(_inner) => {
439 if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
440 write!(f, "unhandled error ({code})")
441 } else {
442 f.write_str("unhandled error")
443 }
444 }
445 }
446 }
447}
448impl ::aws_smithy_types::retry::ProvideErrorKind for StartBackupJobError {
449 fn code(&self) -> ::std::option::Option<&str> {
450 ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
451 }
452 fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
453 ::std::option::Option::None
454 }
455}
456impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartBackupJobError {
457 fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
458 match self {
459 Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
460 Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
461 Self::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
462 Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
463 Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
464 Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
465 Self::Unhandled(_inner) => &_inner.meta,
466 }
467 }
468}
469impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartBackupJobError {
470 fn create_unhandled_error(
471 source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
472 meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
473 ) -> Self {
474 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
475 source,
476 meta: meta.unwrap_or_default(),
477 })
478 }
479}
480impl ::aws_types::request_id::RequestId for crate::operation::start_backup_job::StartBackupJobError {
481 fn request_id(&self) -> Option<&str> {
482 self.meta().request_id()
483 }
484}
485
486pub use crate::operation::start_backup_job::_start_backup_job_input::StartBackupJobInput;
487
488pub use crate::operation::start_backup_job::_start_backup_job_output::StartBackupJobOutput;
489
490mod _start_backup_job_input;
491
492mod _start_backup_job_output;
493
494pub mod builders;