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                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
135            ))
136            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
137                StartReportJobEndpointParamsInterceptor,
138            ))
139            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
140                crate::operation::start_report_job::StartReportJobError,
141            >::new())
142            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
143                crate::operation::start_report_job::StartReportJobError,
144            >::new())
145            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
146                crate::operation::start_report_job::StartReportJobError,
147            >::new());
148
149        ::std::borrow::Cow::Owned(rcb)
150    }
151}
152
153#[derive(Debug)]
154struct StartReportJobResponseDeserializer;
155impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartReportJobResponseDeserializer {
156    fn deserialize_nonstreaming(
157        &self,
158        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
159    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
160        let (success, status) = (response.status().is_success(), response.status().as_u16());
161        let headers = response.headers();
162        let body = response.body().bytes().expect("body loaded");
163        #[allow(unused_mut)]
164        let mut force_error = false;
165        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
166        let parse_result = if !success && status != 200 || force_error {
167            crate::protocol_serde::shape_start_report_job::de_start_report_job_http_error(status, headers, body)
168        } else {
169            crate::protocol_serde::shape_start_report_job::de_start_report_job_http_response(status, headers, body)
170        };
171        crate::protocol_serde::type_erase_result(parse_result)
172    }
173}
174#[derive(Debug)]
175struct StartReportJobRequestSerializer;
176impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartReportJobRequestSerializer {
177    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
178    fn serialize_input(
179        &self,
180        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
181        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
182    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
183        let input = input
184            .downcast::<crate::operation::start_report_job::StartReportJobInput>()
185            .expect("correct type");
186        let _header_serialization_settings = _cfg
187            .load::<crate::serialization_settings::HeaderSerializationSettings>()
188            .cloned()
189            .unwrap_or_default();
190        let mut request_builder = {
191            #[allow(clippy::uninlined_format_args)]
192            fn uri_base(
193                _input: &crate::operation::start_report_job::StartReportJobInput,
194                output: &mut ::std::string::String,
195            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
196                use ::std::fmt::Write as _;
197                let input_1 = &_input.report_plan_name;
198                let input_1 = input_1
199                    .as_ref()
200                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("report_plan_name", "cannot be empty or unset"))?;
201                let report_plan_name = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
202                if report_plan_name.is_empty() {
203                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
204                        "report_plan_name",
205                        "cannot be empty or unset",
206                    ));
207                }
208                ::std::write!(output, "/audit/report-jobs/{ReportPlanName}", ReportPlanName = report_plan_name).expect("formatting should succeed");
209                ::std::result::Result::Ok(())
210            }
211            #[allow(clippy::unnecessary_wraps)]
212            fn update_http_builder(
213                input: &crate::operation::start_report_job::StartReportJobInput,
214                builder: ::http_1x::request::Builder,
215            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
216                let mut uri = ::std::string::String::new();
217                uri_base(input, &mut uri)?;
218                ::std::result::Result::Ok(builder.method("POST").uri(uri))
219            }
220            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
221            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/json");
222            builder
223        };
224        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_start_report_job::ser_start_report_job_input(&input)?);
225        if let Some(content_length) = body.content_length() {
226            let content_length = content_length.to_string();
227            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
228        }
229        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
230    }
231}
232#[derive(Debug)]
233struct StartReportJobEndpointParamsInterceptor;
234
235#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
236impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartReportJobEndpointParamsInterceptor {
237    fn name(&self) -> &'static str {
238        "StartReportJobEndpointParamsInterceptor"
239    }
240
241    fn read_before_execution(
242        &self,
243        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
244            '_,
245            ::aws_smithy_runtime_api::client::interceptors::context::Input,
246            ::aws_smithy_runtime_api::client::interceptors::context::Output,
247            ::aws_smithy_runtime_api::client::interceptors::context::Error,
248        >,
249        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
250    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
251        let _input = context
252            .input()
253            .downcast_ref::<StartReportJobInput>()
254            .ok_or("failed to downcast to StartReportJobInput")?;
255
256        let params = crate::config::endpoint::Params::builder()
257            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
258            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
259            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
260            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
261            .build()
262            .map_err(|err| {
263                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
264            })?;
265        cfg.interceptor_state()
266            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
267        ::std::result::Result::Ok(())
268    }
269}
270
271// The get_* functions below are generated from JMESPath expressions in the
272// operationContextParams trait. They target the operation's input shape.
273
274/// Error type for the `StartReportJobError` operation.
275#[non_exhaustive]
276#[derive(::std::fmt::Debug)]
277pub enum StartReportJobError {
278    /// <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
279    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
280    /// <p>Indicates that a required parameter is missing.</p>
281    MissingParameterValueException(crate::types::error::MissingParameterValueException),
282    /// <p>A resource that is required for the action doesn't exist.</p>
283    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
284    /// <p>The request failed due to a temporary failure of the server.</p>
285    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
286    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
287    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
288    variable wildcard pattern and check `.code()`:
289     \
290    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
291     \
292    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartReportJobError) for what information is available for the error.")]
293    Unhandled(crate::error::sealed_unhandled::Unhandled),
294}
295impl StartReportJobError {
296    /// Creates the `StartReportJobError::Unhandled` variant from any error type.
297    pub fn unhandled(
298        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
299    ) -> Self {
300        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
301            source: err.into(),
302            meta: ::std::default::Default::default(),
303        })
304    }
305
306    /// Creates the `StartReportJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
307    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
308        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
309            source: err.clone().into(),
310            meta: err,
311        })
312    }
313    ///
314    /// Returns error metadata, which includes the error code, message,
315    /// request ID, and potentially additional information.
316    ///
317    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
318        match self {
319            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
320            Self::MissingParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
321            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
322            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
323            Self::Unhandled(e) => &e.meta,
324        }
325    }
326    /// Returns `true` if the error kind is `StartReportJobError::InvalidParameterValueException`.
327    pub fn is_invalid_parameter_value_exception(&self) -> bool {
328        matches!(self, Self::InvalidParameterValueException(_))
329    }
330    /// Returns `true` if the error kind is `StartReportJobError::MissingParameterValueException`.
331    pub fn is_missing_parameter_value_exception(&self) -> bool {
332        matches!(self, Self::MissingParameterValueException(_))
333    }
334    /// Returns `true` if the error kind is `StartReportJobError::ResourceNotFoundException`.
335    pub fn is_resource_not_found_exception(&self) -> bool {
336        matches!(self, Self::ResourceNotFoundException(_))
337    }
338    /// Returns `true` if the error kind is `StartReportJobError::ServiceUnavailableException`.
339    pub fn is_service_unavailable_exception(&self) -> bool {
340        matches!(self, Self::ServiceUnavailableException(_))
341    }
342}
343impl ::std::error::Error for StartReportJobError {
344    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
345        match self {
346            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
347            Self::MissingParameterValueException(_inner) => ::std::option::Option::Some(_inner),
348            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
349            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
350            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
351        }
352    }
353}
354impl ::std::fmt::Display for StartReportJobError {
355    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
356        match self {
357            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
358            Self::MissingParameterValueException(_inner) => _inner.fmt(f),
359            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
360            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
361            Self::Unhandled(_inner) => {
362                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
363                    write!(f, "unhandled error ({code})")
364                } else {
365                    f.write_str("unhandled error")
366                }
367            }
368        }
369    }
370}
371impl ::aws_smithy_types::retry::ProvideErrorKind for StartReportJobError {
372    fn code(&self) -> ::std::option::Option<&str> {
373        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
374    }
375    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
376        ::std::option::Option::None
377    }
378}
379impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartReportJobError {
380    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
381        match self {
382            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
383            Self::MissingParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
384            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
385            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
386            Self::Unhandled(_inner) => &_inner.meta,
387        }
388    }
389}
390impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartReportJobError {
391    fn create_unhandled_error(
392        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
393        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
394    ) -> Self {
395        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
396            source,
397            meta: meta.unwrap_or_default(),
398        })
399    }
400}
401impl ::aws_types::request_id::RequestId for crate::operation::start_report_job::StartReportJobError {
402    fn request_id(&self) -> Option<&str> {
403        self.meta().request_id()
404    }
405}
406
407pub use crate::operation::start_report_job::_start_report_job_input::StartReportJobInput;
408
409pub use crate::operation::start_report_job::_start_report_job_output::StartReportJobOutput;
410
411mod _start_report_job_input;
412
413mod _start_report_job_output;
414
415/// Builders
416pub mod builders;
aws_sdk_backup/operation/start_report_job.rs

aws_sdk_backup/operation/
start_report_job.rs
