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
146 ::std::borrow::Cow::Owned(rcb)
147 }
148}
149
150#[derive(Debug)]
151struct GetBackupPlanTelemetryInputCaptureInterceptor;
152
153#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
154impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetBackupPlanTelemetryInputCaptureInterceptor {
155 fn name(&self) -> &'static str {
156 "GetBackupPlanTelemetryInputCaptureInterceptor"
157 }
158
159 fn read_before_execution(
160 &self,
161 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
162 '_,
163 ::aws_smithy_runtime_api::client::interceptors::context::Input,
164 ::aws_smithy_runtime_api::client::interceptors::context::Output,
165 ::aws_smithy_runtime_api::client::interceptors::context::Error,
166 >,
167 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
168 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
169 let ::std::option::Option::Some(requested) = cfg
171 .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
172 .filter(|r| !r.is_empty())
173 else {
174 return ::std::result::Result::Ok(());
175 };
176
177 let ::std::option::Option::Some(input) = context.input().downcast_ref::<GetBackupPlanInput>() else {
178 return ::std::result::Result::Ok(());
180 };
181
182 let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
183 if requested.should_capture("BackupPlanId") {
184 if let ::std::option::Option::Some(value) = input.backup_plan_id.as_deref() {
185 captured.insert("BackupPlanId", value);
186 }
187 }
188 if requested.should_capture("VersionId") {
189 if let ::std::option::Option::Some(value) = input.version_id.as_deref() {
190 captured.insert("VersionId", value);
191 }
192 }
193
194 cfg.interceptor_state().store_put(captured);
195 ::std::result::Result::Ok(())
196 }
197}
198#[derive(Debug)]
199struct GetBackupPlanResponseDeserializer;
200impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetBackupPlanResponseDeserializer {
201 fn deserialize_nonstreaming_with_config(
202 &self,
203 response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
204 _cfg: &::aws_smithy_types::config_bag::ConfigBag,
205 ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
206 let (success, status) = (response.status().is_success(), response.status().as_u16());
207 let headers = response.headers();
208 let body = response.body().bytes().expect("body loaded");
209 #[allow(unused_mut)]
210 let mut force_error = false;
211 ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
212 let parse_result = if !success && status != 200 || force_error {
213 crate::protocol_serde::shape_get_backup_plan::de_get_backup_plan_http_error(status, headers, body)
214 } else {
215 crate::protocol_serde::shape_get_backup_plan::de_get_backup_plan_http_response(status, headers, body)
216 };
217 crate::protocol_serde::type_erase_result(parse_result)
218 }
219}
220#[derive(Debug)]
221struct GetBackupPlanRequestSerializer;
222impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetBackupPlanRequestSerializer {
223 #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
224 fn serialize_input(
225 &self,
226 input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
227 _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
228 ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
229 let input = input
230 .downcast::<crate::operation::get_backup_plan::GetBackupPlanInput>()
231 .expect("correct type");
232 let _header_serialization_settings = _cfg
233 .load::<crate::serialization_settings::HeaderSerializationSettings>()
234 .cloned()
235 .unwrap_or_default();
236 let mut request_builder = {
237 #[allow(clippy::uninlined_format_args)]
238 fn uri_base(
239 _input: &crate::operation::get_backup_plan::GetBackupPlanInput,
240 output: &mut ::std::string::String,
241 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
242 use ::std::fmt::Write as _;
243 let input_1 = &_input.backup_plan_id;
244 let input_1 = input_1
245 .as_ref()
246 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("backup_plan_id", "cannot be empty or unset"))?;
247 let backup_plan_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
248 if backup_plan_id.is_empty() {
249 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
250 "backup_plan_id",
251 "cannot be empty or unset",
252 ));
253 }
254 ::std::write!(output, "/backup/plans/{BackupPlanId}", BackupPlanId = backup_plan_id).expect("formatting should succeed");
255 ::std::result::Result::Ok(())
256 }
257 fn uri_query(
258 _input: &crate::operation::get_backup_plan::GetBackupPlanInput,
259 mut output: &mut ::std::string::String,
260 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
261 let mut query = ::aws_smithy_http::query::Writer::new(output);
262 if let ::std::option::Option::Some(inner_2) = &_input.version_id {
263 {
264 query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
265 }
266 }
267 if let ::std::option::Option::Some(inner_3) = &_input.max_scheduled_runs_preview {
268 {
269 query.push_kv("MaxScheduledRunsPreview", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
270 }
271 }
272 ::std::result::Result::Ok(())
273 }
274 #[allow(clippy::unnecessary_wraps)]
275 fn update_http_builder(
276 input: &crate::operation::get_backup_plan::GetBackupPlanInput,
277 builder: ::http_1x::request::Builder,
278 ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
279 let mut uri = ::std::string::String::new();
280 uri_base(input, &mut uri)?;
281 uri_query(input, &mut uri)?;
282 ::std::result::Result::Ok(builder.method("GET").uri(uri))
283 }
284 let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
285 builder
286 };
287 let body = ::aws_smithy_types::body::SdkBody::from("");
288
289 ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
290 }
291}
292#[derive(Debug)]
293struct GetBackupPlanEndpointParamsInterceptor;
294
295#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
296impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetBackupPlanEndpointParamsInterceptor {
297 fn name(&self) -> &'static str {
298 "GetBackupPlanEndpointParamsInterceptor"
299 }
300
301 fn read_before_execution(
302 &self,
303 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
304 '_,
305 ::aws_smithy_runtime_api::client::interceptors::context::Input,
306 ::aws_smithy_runtime_api::client::interceptors::context::Output,
307 ::aws_smithy_runtime_api::client::interceptors::context::Error,
308 >,
309 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
310 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
311 let _input = context
312 .input()
313 .downcast_ref::<GetBackupPlanInput>()
314 .ok_or("failed to downcast to GetBackupPlanInput")?;
315
316 let params = crate::config::endpoint::Params::builder()
317 .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
318 .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
319 .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
320 .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
321 .build()
322 .map_err(|err| {
323 ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
324 })?;
325 cfg.interceptor_state()
326 .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
327 ::std::result::Result::Ok(())
328 }
329}
330
331#[non_exhaustive]
336#[derive(::std::fmt::Debug)]
337pub enum GetBackupPlanError {
338 InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
340 MissingParameterValueException(crate::types::error::MissingParameterValueException),
342 ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
344 ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
346 #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
348 variable wildcard pattern and check `.code()`:
349 \
350 `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
351 \
352 See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetBackupPlanError) for what information is available for the error.")]
353 Unhandled(crate::error::sealed_unhandled::Unhandled),
354}
355impl GetBackupPlanError {
356 pub fn unhandled(
358 err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
359 ) -> Self {
360 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
361 source: err.into(),
362 meta: ::std::default::Default::default(),
363 })
364 }
365
366 pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
368 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
369 source: err.clone().into(),
370 meta: err,
371 })
372 }
373 pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
378 match self {
379 Self::InvalidParameterValueException(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_missing_parameter_value_exception(&self) -> bool {
392 matches!(self, Self::MissingParameterValueException(_))
393 }
394 pub fn is_resource_not_found_exception(&self) -> bool {
396 matches!(self, Self::ResourceNotFoundException(_))
397 }
398 pub fn is_service_unavailable_exception(&self) -> bool {
400 matches!(self, Self::ServiceUnavailableException(_))
401 }
402}
403impl ::std::error::Error for GetBackupPlanError {
404 fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
405 match self {
406 Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
407 Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
408 Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
409 Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
410 Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
411 }
412 }
413}
414impl ::std::fmt::Display for GetBackupPlanError {
415 fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
416 match self {
417 Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
418 Self::MissingParameterValueException(_inner) => _inner.fmt(f),
419 Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
420 Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
421 Self::Unhandled(_inner) => {
422 if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
423 write!(f, "unhandled error ({code})")
424 } else {
425 f.write_str("unhandled error")
426 }
427 }
428 }
429 }
430}
431impl ::aws_smithy_types::retry::ProvideErrorKind for GetBackupPlanError {
432 fn code(&self) -> ::std::option::Option<&str> {
433 ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
434 }
435 fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
436 ::std::option::Option::None
437 }
438}
439impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetBackupPlanError {
440 fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
441 match self {
442 Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
443 Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
444 Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
445 Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
446 Self::Unhandled(_inner) => &_inner.meta,
447 }
448 }
449}
450impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetBackupPlanError {
451 fn create_unhandled_error(
452 source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
453 meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
454 ) -> Self {
455 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
456 source,
457 meta: meta.unwrap_or_default(),
458 })
459 }
460}
461impl ::aws_types::request_id::RequestId for crate::operation::get_backup_plan::GetBackupPlanError {
462 fn request_id(&self) -> Option<&str> {
463 self.meta().request_id()
464 }
465}
466
467pub use crate::operation::get_backup_plan::_get_backup_plan_input::GetBackupPlanInput;
468
469pub use crate::operation::get_backup_plan::_get_backup_plan_output::GetBackupPlanOutput;
470
471mod _get_backup_plan_input;
472
473mod _get_backup_plan_output;
474
475pub mod builders;