aws_sdk_backup/operation/
start_report_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StartReportJob`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartReportJob;
6impl StartReportJob {
7    /// Creates a new `StartReportJob`
8    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_report_job::StartReportJobInput,
14    ) -> ::std::result::Result<
15        crate::operation::start_report_job::StartReportJobOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::start_report_job::StartReportJobError,
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_report_job::StartReportJobError>()
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_report_job::StartReportJobOutput>()
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_report_job::StartReportJobInput,
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", "StartReportJob", input, runtime_plugins, stop_point)
55            // Create a parent span for the entire operation. Includes a random, internal-only,
56            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
57            .instrument(::tracing::debug_span!(
58                "Backup.StartReportJob",
59                "rpc.service" = "Backup",
60                "rpc.method" = "StartReportJob",
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_report_job::StartReportJobInput = 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 StartReportJob {
95    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
96        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StartReportJob");
97
98        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
99            StartReportJobRequestSerializer,
100        ));
101        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
102            StartReportJobResponseDeserializer,
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
106            crate::config::auth::Params::builder()
107                .operation_name("StartReportJob")
108                .build()
109                .expect("required fields set"),
110        ));
111
112        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("StartReportJob", "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("StartReportJob")
133            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
134                StartReportJobTelemetryInputCaptureInterceptor,
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                StartReportJobEndpointParamsInterceptor,
141            ))
142            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
143                crate::operation::start_report_job::StartReportJobError,
144            >::new())
145            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
146                crate::operation::start_report_job::StartReportJobError,
147            >::new())
148            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
149                crate::operation::start_report_job::StartReportJobError,
150            >::new());
151
152        ::std::borrow::Cow::Owned(rcb)
153    }
154}
155
156#[derive(Debug)]
157struct StartReportJobTelemetryInputCaptureInterceptor;
158
159#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
160impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartReportJobTelemetryInputCaptureInterceptor {
161    fn name(&self) -> &'static str {
162        "StartReportJobTelemetryInputCaptureInterceptor"
163    }
164
165    fn read_before_execution(
166        &self,
167        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
168            '_,
169            ::aws_smithy_runtime_api::client::interceptors::context::Input,
170            ::aws_smithy_runtime_api::client::interceptors::context::Output,
171            ::aws_smithy_runtime_api::client::interceptors::context::Error,
172        >,
173        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
175        // Nothing to do unless the customer opted in by naming members to record.
176        let ::std::option::Option::Some(requested) = cfg
177            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
178            .filter(|r| !r.is_empty())
179        else {
180            return ::std::result::Result::Ok(());
181        };
182
183        let ::std::option::Option::Some(input) = context.input().downcast_ref::<StartReportJobInput>() else {
184            // A mismatched input is not this interceptor's concern; skip quietly.
185            return ::std::result::Result::Ok(());
186        };
187
188        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
189        if requested.should_capture("ReportPlanName") {
190            if let ::std::option::Option::Some(value) = input.report_plan_name.as_deref() {
191                captured.insert("ReportPlanName", value);
192            }
193        }
194        if requested.should_capture("IdempotencyToken") {
195            if let ::std::option::Option::Some(value) = input.idempotency_token.as_deref() {
196                captured.insert("IdempotencyToken", value);
197            }
198        }
199
200        cfg.interceptor_state().store_put(captured);
201        ::std::result::Result::Ok(())
202    }
203}
204#[derive(Debug)]
205struct StartReportJobResponseDeserializer;
206impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartReportJobResponseDeserializer {
207    fn deserialize_nonstreaming_with_config(
208        &self,
209        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
210        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
211    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
212        let (success, status) = (response.status().is_success(), response.status().as_u16());
213        let headers = response.headers();
214        let body = response.body().bytes().expect("body loaded");
215        #[allow(unused_mut)]
216        let mut force_error = false;
217        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
218        let parse_result = if !success && status != 200 || force_error {
219            crate::protocol_serde::shape_start_report_job::de_start_report_job_http_error(status, headers, body)
220        } else {
221            crate::protocol_serde::shape_start_report_job::de_start_report_job_http_response(status, headers, body)
222        };
223        crate::protocol_serde::type_erase_result(parse_result)
224    }
225}
226#[derive(Debug)]
227struct StartReportJobRequestSerializer;
228impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartReportJobRequestSerializer {
229    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
230    fn serialize_input(
231        &self,
232        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
233        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
234    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
235        let input = input
236            .downcast::<crate::operation::start_report_job::StartReportJobInput>()
237            .expect("correct type");
238        let _header_serialization_settings = _cfg
239            .load::<crate::serialization_settings::HeaderSerializationSettings>()
240            .cloned()
241            .unwrap_or_default();
242        let mut request_builder = {
243            #[allow(clippy::uninlined_format_args)]
244            fn uri_base(
245                _input: &crate::operation::start_report_job::StartReportJobInput,
246                output: &mut ::std::string::String,
247            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
248                use ::std::fmt::Write as _;
249                let input_1 = &_input.report_plan_name;
250                let input_1 = input_1
251                    .as_ref()
252                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("report_plan_name", "cannot be empty or unset"))?;
253                let report_plan_name = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
254                if report_plan_name.is_empty() {
255                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
256                        "report_plan_name",
257                        "cannot be empty or unset",
258                    ));
259                }
260                ::std::write!(output, "/audit/report-jobs/{ReportPlanName}", ReportPlanName = report_plan_name).expect("formatting should succeed");
261                ::std::result::Result::Ok(())
262            }
263            #[allow(clippy::unnecessary_wraps)]
264            fn update_http_builder(
265                input: &crate::operation::start_report_job::StartReportJobInput,
266                builder: ::http_1x::request::Builder,
267            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
268                let mut uri = ::std::string::String::new();
269                uri_base(input, &mut uri)?;
270                ::std::result::Result::Ok(builder.method("POST").uri(uri))
271            }
272            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
273            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/json");
274            builder
275        };
276        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_start_report_job::ser_start_report_job_input(&input)?);
277        if let Some(content_length) = body.content_length() {
278            let content_length = content_length.to_string();
279            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
280        }
281        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
282    }
283}
284#[derive(Debug)]
285struct StartReportJobEndpointParamsInterceptor;
286
287#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
288impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartReportJobEndpointParamsInterceptor {
289    fn name(&self) -> &'static str {
290        "StartReportJobEndpointParamsInterceptor"
291    }
292
293    fn read_before_execution(
294        &self,
295        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
296            '_,
297            ::aws_smithy_runtime_api::client::interceptors::context::Input,
298            ::aws_smithy_runtime_api::client::interceptors::context::Output,
299            ::aws_smithy_runtime_api::client::interceptors::context::Error,
300        >,
301        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
302    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
303        let _input = context
304            .input()
305            .downcast_ref::<StartReportJobInput>()
306            .ok_or("failed to downcast to StartReportJobInput")?;
307
308        let params = crate::config::endpoint::Params::builder()
309            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
310            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
311            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
312            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
313            .build()
314            .map_err(|err| {
315                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
316            })?;
317        cfg.interceptor_state()
318            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
319        ::std::result::Result::Ok(())
320    }
321}
322
323// The get_* functions below are generated from JMESPath expressions in the
324// operationContextParams trait. They target the operation's input shape.
325
326/// Error type for the `StartReportJobError` operation.
327#[non_exhaustive]
328#[derive(::std::fmt::Debug)]
329pub enum StartReportJobError {
330    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
331    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
332    /// <p>Indicates that a required parameter is missing.</p>
333    MissingParameterValueException(crate::types::error::MissingParameterValueException),
334    /// <p>A resource that is required for the action doesn't exist.</p>
335    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
336    /// <p>The request failed due to a temporary failure of the server.</p>
337    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
338    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
339    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
340    variable wildcard pattern and check `.code()`:
341     \
342    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
343     \
344    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartReportJobError) for what information is available for the error.")]
345    Unhandled(crate::error::sealed_unhandled::Unhandled),
346}
347impl StartReportJobError {
348    /// Creates the `StartReportJobError::Unhandled` variant from any error type.
349    pub fn unhandled(
350        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
351    ) -> Self {
352        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
353            source: err.into(),
354            meta: ::std::default::Default::default(),
355        })
356    }
357
358    /// Creates the `StartReportJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
359    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
360        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
361            source: err.clone().into(),
362            meta: err,
363        })
364    }
365    ///
366    /// Returns error metadata, which includes the error code, message,
367    /// request ID, and potentially additional information.
368    ///
369    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
370        match self {
371            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
372            Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
373            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
374            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
375            Self::Unhandled(e) => &e.meta,
376        }
377    }
378    /// Returns `true` if the error kind is `StartReportJobError::InvalidParameterValueException`.
379    pub fn is_invalid_parameter_value_exception(&self) -> bool {
380        matches!(self, Self::InvalidParameterValueException(_))
381    }
382    /// Returns `true` if the error kind is `StartReportJobError::MissingParameterValueException`.
383    pub fn is_missing_parameter_value_exception(&self) -> bool {
384        matches!(self, Self::MissingParameterValueException(_))
385    }
386    /// Returns `true` if the error kind is `StartReportJobError::ResourceNotFoundException`.
387    pub fn is_resource_not_found_exception(&self) -> bool {
388        matches!(self, Self::ResourceNotFoundException(_))
389    }
390    /// Returns `true` if the error kind is `StartReportJobError::ServiceUnavailableException`.
391    pub fn is_service_unavailable_exception(&self) -> bool {
392        matches!(self, Self::ServiceUnavailableException(_))
393    }
394}
395impl ::std::error::Error for StartReportJobError {
396    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
397        match self {
398            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
399            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
400            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
401            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
402            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
403        }
404    }
405}
406impl ::std::fmt::Display for StartReportJobError {
407    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
408        match self {
409            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
410            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
411            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
412            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
413            Self::Unhandled(_inner) => {
414                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
415                    write!(f, "unhandled error ({code})")
416                } else {
417                    f.write_str("unhandled error")
418                }
419            }
420        }
421    }
422}
423impl ::aws_smithy_types::retry::ProvideErrorKind for StartReportJobError {
424    fn code(&self) -> ::std::option::Option<&str> {
425        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
426    }
427    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
428        ::std::option::Option::None
429    }
430}
431impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartReportJobError {
432    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
433        match self {
434            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
435            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
436            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
437            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
438            Self::Unhandled(_inner) => &_inner.meta,
439        }
440    }
441}
442impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartReportJobError {
443    fn create_unhandled_error(
444        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
445        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
446    ) -> Self {
447        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
448            source,
449            meta: meta.unwrap_or_default(),
450        })
451    }
452}
453impl ::aws_types::request_id::RequestId for crate::operation::start_report_job::StartReportJobError {
454    fn request_id(&self) -> Option<&str> {
455        self.meta().request_id()
456    }
457}
458
459pub use crate::operation::start_report_job::_start_report_job_input::StartReportJobInput;
460
461pub use crate::operation::start_report_job::_start_report_job_output::StartReportJobOutput;
462
463mod _start_report_job_input;
464
465mod _start_report_job_output;
466
467/// Builders
468pub mod builders;
aws_sdk_backup/operation/start_report_job.rs

aws_sdk_backup/operation/
start_report_job.rs
