aws_sdk_backup/operation/
get_backup_plan.rs1#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetBackupPlan;
6impl GetBackupPlan {
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::get_backup_plan::GetBackupPlanInput,
14 ) -> ::std::result::Result<
15 crate::operation::get_backup_plan::GetBackupPlanOutput,
16 ::aws_smithy_runtime_api::client::result::SdkError<
17 crate::operation::get_backup_plan::GetBackupPlanError,
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::get_backup_plan::GetBackupPlanError>()
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::get_backup_plan::GetBackupPlanOutput>()
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::get_backup_plan::GetBackupPlanInput,
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", "GetBackupPlan", input, runtime_plugins, stop_point)
55 .instrument(::tracing::debug_span!(
58 "Backup.GetBackupPlan",
59 "rpc.service" = "Backup",
60 "rpc.method" = "GetBackupPlan",
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 GetBackupPlan {
88 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89 let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetBackupPlan");
90
91 cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92 GetBackupPlanRequestSerializer,
93 ));
94 cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95 GetBackupPlanResponseDeserializer,
96 ));
97
98 cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99 crate::config::auth::Params::builder()
100 .operation_name("GetBackupPlan")
101 .build()
102 .expect("required fields set"),
103 ));
104
105 cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
106 cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("GetBackupPlan", "Backup"));
107 let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
108 signing_options.double_uri_encode = true;
109 signing_options.content_sha256_header = false;
110 signing_options.normalize_uri_path = true;
111 signing_options.payload_override = None;
112
113 cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
114 signing_options,
115 ..::std::default::Default::default()
116 });
117
118 ::std::option::Option::Some(cfg.freeze())
119 }
120
121 fn runtime_components(
122 &self,
123 _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
124 ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
125 #[allow(unused_mut)]
126 let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetBackupPlan")
127 .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
128 GetBackupPlanTelemetryInputCaptureInterceptor,
129 ))
130 .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
131 ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
132 ))
133 .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
134 GetBackupPlanEndpointParamsInterceptor,
135 ))
136 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
137 crate::operation::get_backup_plan::GetBackupPlanError,
138 >::new())
139 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
140 crate::operation::get_backup_plan::GetBackupPlanError,
141 >::new())
142 .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
143 crate::operation::get_backup_plan::GetBackupPlanError,
144 >::new())
145 .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
146 crate::operation::get_backup_plan::GetBackupPlanError,
147 >::new());
148
149 ::std::borrow::Cow::Owned(rcb)
150 }
151}
152
153#[derive(Debug)]
154struct GetBackupPlanTelemetryInputCaptureInterceptor;
155
156#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
157impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetBackupPlanTelemetryInputCaptureInterceptor {
158 fn name(&self) -> &'static str {
159 "GetBackupPlanTelemetryInputCaptureInterceptor"
160 }
161
162 fn read_before_execution(
163 &self,
164 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
165 '_,
166 ::aws_smithy_runtime_api::client::interceptors::context::Input,
167 ::aws_smithy_runtime_api::client::interceptors::context::Output,
168 ::aws_smithy_runtime_api::client::interceptors::context::Error,
169 >,
170 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
171 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
172 let ::std::option::Option::Some(requested) = cfg
174 .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
175 .filter(|r| !r.is_empty())
176 else {
177 return ::std::result::Result::Ok(());
178 };
179
180 let ::std::option::Option::Some(input) = context.input().downcast_ref::<GetBackupPlanInput>() else {
181 return ::std::result::Result::Ok(());
183 };
184
185 let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
186 if requested.should_capture("BackupPlanId") {
187 if let ::std::option::Option::Some(value) = input.backup_plan_id.as_deref() {
188 captured.insert("BackupPlanId", value);
189 }
190 }
191 if requested.should_capture("VersionId") {
192 if let ::std::option::Option::Some(value) = input.version_id.as_deref() {
193 captured.insert("VersionId", value);
194 }
195 }
196
197 cfg.interceptor_state().store_put(captured);
198 ::std::result::Result::Ok(())
199 }
200}
201#[derive(Debug)]
202struct GetBackupPlanResponseDeserializer;
203impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetBackupPlanResponseDeserializer {
204 fn deserialize_nonstreaming_with_config(
205 &self,
206 response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
207 _cfg: &::aws_smithy_types::config_bag::ConfigBag,
208 ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
209 let (success, status) = (response.status().is_success(), response.status().as_u16());
210 let headers = response.headers();
211 let body = response.body().bytes().expect("body loaded");
212 #[allow(unused_mut)]
213 let mut force_error = false;
214 ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
215 let parse_result = if !success && status != 200 || force_error {
216 crate::protocol_serde::shape_get_backup_plan::de_get_backup_plan_http_error(status, headers, body)
217 } else {
218 crate::protocol_serde::shape_get_backup_plan::de_get_backup_plan_http_response(status, headers, body)
219 };
220 crate::protocol_serde::type_erase_result(parse_result)
221 }
222}
223#[derive(Debug)]
224struct GetBackupPlanRequestSerializer;
225impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetBackupPlanRequestSerializer {
226 #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
227 fn serialize_input(
228 &self,
229 input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
230 _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
231 ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
232 let input = input
233 .downcast::<crate::operation::get_backup_plan::GetBackupPlanInput>()
234 .expect("correct type");
235 let _header_serialization_settings = _cfg
236 .load::<crate::serialization_settings::HeaderSerializationSettings>()
237 .cloned()
238 .unwrap_or_default();
239 let mut request_builder = {
240 #[allow(clippy::uninlined_format_args)]
241 fn uri_base(
242 _input: &crate::operation::get_backup_plan::GetBackupPlanInput,
243 output: &mut ::std::string::String,
244 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
245 use ::std::fmt::Write as _;
246 let input_1 = &_input.backup_plan_id;
247 let input_1 = input_1
248 .as_ref()
249 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("backup_plan_id", "cannot be empty or unset"))?;
250 let backup_plan_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
251 if backup_plan_id.is_empty() {
252 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
253 "backup_plan_id",
254 "cannot be empty or unset",
255 ));
256 }
257 ::std::write!(output, "/backup/plans/{BackupPlanId}", BackupPlanId = backup_plan_id).expect("formatting should succeed");
258 ::std::result::Result::Ok(())
259 }
260 fn uri_query(
261 _input: &crate::operation::get_backup_plan::GetBackupPlanInput,
262 mut output: &mut ::std::string::String,
263 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
264 let mut query = ::aws_smithy_http::query::Writer::new(output);
265 if let ::std::option::Option::Some(inner_2) = &_input.version_id {
266 {
267 query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
268 }
269 }
270 if let ::std::option::Option::Some(inner_3) = &_input.max_scheduled_runs_preview {
271 {
272 query.push_kv("MaxScheduledRunsPreview", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
273 }
274 }
275 ::std::result::Result::Ok(())
276 }
277 #[allow(clippy::unnecessary_wraps)]
278 fn update_http_builder(
279 input: &crate::operation::get_backup_plan::GetBackupPlanInput,
280 builder: ::http_1x::request::Builder,
281 ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
282 let mut uri = ::std::string::String::new();
283 uri_base(input, &mut uri)?;
284 uri_query(input, &mut uri)?;
285 ::std::result::Result::Ok(builder.method("GET").uri(uri))
286 }
287 let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
288 builder
289 };
290 let body = ::aws_smithy_types::body::SdkBody::from("");
291
292 ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
293 }
294}
295#[derive(Debug)]
296struct GetBackupPlanEndpointParamsInterceptor;
297
298#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
299impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetBackupPlanEndpointParamsInterceptor {
300 fn name(&self) -> &'static str {
301 "GetBackupPlanEndpointParamsInterceptor"
302 }
303
304 fn read_before_execution(
305 &self,
306 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
307 '_,
308 ::aws_smithy_runtime_api::client::interceptors::context::Input,
309 ::aws_smithy_runtime_api::client::interceptors::context::Output,
310 ::aws_smithy_runtime_api::client::interceptors::context::Error,
311 >,
312 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
313 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
314 let _input = context
315 .input()
316 .downcast_ref::<GetBackupPlanInput>()
317 .ok_or("failed to downcast to GetBackupPlanInput")?;
318
319 let params = crate::config::endpoint::Params::builder()
320 .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
321 .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
322 .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
323 .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
324 .build()
325 .map_err(|err| {
326 ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
327 })?;
328 cfg.interceptor_state()
329 .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
330 ::std::result::Result::Ok(())
331 }
332}
333
334#[non_exhaustive]
339#[derive(::std::fmt::Debug)]
340pub enum GetBackupPlanError {
341 InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
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-GetBackupPlanError) for what information is available for the error.")]
356 Unhandled(crate::error::sealed_unhandled::Unhandled),
357}
358impl GetBackupPlanError {
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::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_missing_parameter_value_exception(&self) -> bool {
395 matches!(self, Self::MissingParameterValueException(_))
396 }
397 pub fn is_resource_not_found_exception(&self) -> bool {
399 matches!(self, Self::ResourceNotFoundException(_))
400 }
401 pub fn is_service_unavailable_exception(&self) -> bool {
403 matches!(self, Self::ServiceUnavailableException(_))
404 }
405}
406impl ::std::error::Error for GetBackupPlanError {
407 fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
408 match self {
409 Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
410 Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
411 Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
412 Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
413 Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
414 }
415 }
416}
417impl ::std::fmt::Display for GetBackupPlanError {
418 fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
419 match self {
420 Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
421 Self::MissingParameterValueException(_inner) => _inner.fmt(f),
422 Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
423 Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
424 Self::Unhandled(_inner) => {
425 if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
426 write!(f, "unhandled error ({code})")
427 } else {
428 f.write_str("unhandled error")
429 }
430 }
431 }
432 }
433}
434impl ::aws_smithy_types::retry::ProvideErrorKind for GetBackupPlanError {
435 fn code(&self) -> ::std::option::Option<&str> {
436 ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
437 }
438 fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
439 ::std::option::Option::None
440 }
441}
442impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetBackupPlanError {
443 fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
444 match self {
445 Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
446 Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
447 Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
448 Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
449 Self::Unhandled(_inner) => &_inner.meta,
450 }
451 }
452}
453impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetBackupPlanError {
454 fn create_unhandled_error(
455 source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
456 meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
457 ) -> Self {
458 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
459 source,
460 meta: meta.unwrap_or_default(),
461 })
462 }
463}
464impl ::aws_types::request_id::RequestId for crate::operation::get_backup_plan::GetBackupPlanError {
465 fn request_id(&self) -> Option<&str> {
466 self.meta().request_id()
467 }
468}
469
470pub use crate::operation::get_backup_plan::_get_backup_plan_input::GetBackupPlanInput;
471
472pub use crate::operation::get_backup_plan::_get_backup_plan_output::GetBackupPlanOutput;
473
474mod _get_backup_plan_input;
475
476mod _get_backup_plan_output;
477
478pub mod builders;