aws_sdk_iot/operation/
update_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `UpdateJob`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct UpdateJob;
6impl UpdateJob {
7    /// Creates a new `UpdateJob`
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::update_job::UpdateJobInput,
14    ) -> ::std::result::Result<
15        crate::operation::update_job::UpdateJobOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::update_job::UpdateJobError,
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::update_job::UpdateJobError>()
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::update_job::UpdateJobOutput>()
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::update_job::UpdateJobInput,
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        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("iot", "UpdateJob", input, runtime_plugins, stop_point).await
54    }
55
56    pub(crate) fn operation_runtime_plugins(
57        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
58        client_config: &crate::config::Config,
59        config_override: ::std::option::Option<crate::config::Builder>,
60    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
61        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
62        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
63            ::aws_runtime::auth::sigv4::SCHEME_ID,
64        ]));
65        if let ::std::option::Option::Some(config_override) = config_override {
66            for plugin in config_override.runtime_plugins.iter().cloned() {
67                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
68            }
69            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
70                config_override,
71                client_config.config.clone(),
72                &client_config.runtime_components,
73            ));
74        }
75        runtime_plugins
76    }
77}
78impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for UpdateJob {
79    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
80        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("UpdateJob");
81
82        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
83            UpdateJobRequestSerializer,
84        ));
85        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
86            UpdateJobResponseDeserializer,
87        ));
88
89        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
90            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
91        ));
92
93        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("UpdateJob", "iot"));
94        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
95        signing_options.double_uri_encode = true;
96        signing_options.content_sha256_header = false;
97        signing_options.normalize_uri_path = true;
98        signing_options.payload_override = None;
99
100        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
101            signing_options,
102            ..::std::default::Default::default()
103        });
104
105        ::std::option::Option::Some(cfg.freeze())
106    }
107
108    fn runtime_components(
109        &self,
110        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
111    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
112        #[allow(unused_mut)]
113        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("UpdateJob")
114            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
115            .with_interceptor(UpdateJobEndpointParamsInterceptor)
116            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
117                crate::operation::update_job::UpdateJobError,
118            >::new())
119            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
120                crate::operation::update_job::UpdateJobError,
121            >::new())
122            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
123                crate::operation::update_job::UpdateJobError,
124            >::new());
125
126        ::std::borrow::Cow::Owned(rcb)
127    }
128}
129
130#[derive(Debug)]
131struct UpdateJobResponseDeserializer;
132impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for UpdateJobResponseDeserializer {
133    fn deserialize_nonstreaming(
134        &self,
135        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
136    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
137        let (success, status) = (response.status().is_success(), response.status().as_u16());
138        let headers = response.headers();
139        let body = response.body().bytes().expect("body loaded");
140        #[allow(unused_mut)]
141        let mut force_error = false;
142        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
143        let parse_result = if !success && status != 200 || force_error {
144            crate::protocol_serde::shape_update_job::de_update_job_http_error(status, headers, body)
145        } else {
146            crate::protocol_serde::shape_update_job::de_update_job_http_response(status, headers, body)
147        };
148        crate::protocol_serde::type_erase_result(parse_result)
149    }
150}
151#[derive(Debug)]
152struct UpdateJobRequestSerializer;
153impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for UpdateJobRequestSerializer {
154    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
155    fn serialize_input(
156        &self,
157        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
158        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
159    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
160        let input = input.downcast::<crate::operation::update_job::UpdateJobInput>().expect("correct type");
161        let _header_serialization_settings = _cfg
162            .load::<crate::serialization_settings::HeaderSerializationSettings>()
163            .cloned()
164            .unwrap_or_default();
165        let mut request_builder = {
166            fn uri_base(
167                _input: &crate::operation::update_job::UpdateJobInput,
168                output: &mut ::std::string::String,
169            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
170                use ::std::fmt::Write as _;
171                let input_1 = &_input.job_id;
172                let input_1 = input_1
173                    .as_ref()
174                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("job_id", "cannot be empty or unset"))?;
175                let job_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
176                if job_id.is_empty() {
177                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
178                        "job_id",
179                        "cannot be empty or unset",
180                    ));
181                }
182                ::std::write!(output, "/jobs/{jobId}", jobId = job_id).expect("formatting should succeed");
183                ::std::result::Result::Ok(())
184            }
185            fn uri_query(
186                _input: &crate::operation::update_job::UpdateJobInput,
187                mut output: &mut ::std::string::String,
188            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
189                let mut query = ::aws_smithy_http::query::Writer::new(output);
190                if let ::std::option::Option::Some(inner_2) = &_input.namespace_id {
191                    {
192                        query.push_kv("namespaceId", &::aws_smithy_http::query::fmt_string(inner_2));
193                    }
194                }
195                ::std::result::Result::Ok(())
196            }
197            #[allow(clippy::unnecessary_wraps)]
198            fn update_http_builder(
199                input: &crate::operation::update_job::UpdateJobInput,
200                builder: ::http::request::Builder,
201            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
202                let mut uri = ::std::string::String::new();
203                uri_base(input, &mut uri)?;
204                uri_query(input, &mut uri)?;
205                ::std::result::Result::Ok(builder.method("PATCH").uri(uri))
206            }
207            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
208            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/json");
209            builder
210        };
211        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_update_job::ser_update_job_input(&input)?);
212        if let Some(content_length) = body.content_length() {
213            let content_length = content_length.to_string();
214            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
215        }
216        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
217    }
218}
219#[derive(Debug)]
220struct UpdateJobEndpointParamsInterceptor;
221
222impl ::aws_smithy_runtime_api::client::interceptors::Intercept for UpdateJobEndpointParamsInterceptor {
223    fn name(&self) -> &'static str {
224        "UpdateJobEndpointParamsInterceptor"
225    }
226
227    fn read_before_execution(
228        &self,
229        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
230            '_,
231            ::aws_smithy_runtime_api::client::interceptors::context::Input,
232            ::aws_smithy_runtime_api::client::interceptors::context::Output,
233            ::aws_smithy_runtime_api::client::interceptors::context::Error,
234        >,
235        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
236    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
237        let _input = context
238            .input()
239            .downcast_ref::<UpdateJobInput>()
240            .ok_or("failed to downcast to UpdateJobInput")?;
241
242        let params = crate::config::endpoint::Params::builder()
243            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
244            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
245            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
246            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
247            .build()
248            .map_err(|err| {
249                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
250            })?;
251        cfg.interceptor_state()
252            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
253        ::std::result::Result::Ok(())
254    }
255}
256
257// The get_* functions below are generated from JMESPath expressions in the
258// operationContextParams trait. They target the operation's input shape.
259
260/// Error type for the `UpdateJobError` operation.
261#[non_exhaustive]
262#[derive(::std::fmt::Debug)]
263pub enum UpdateJobError {
264    /// <p>The request is not valid.</p>
265    InvalidRequestException(crate::types::error::InvalidRequestException),
266    /// <p>The specified resource does not exist.</p>
267    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
268    /// <p>The service is temporarily unavailable.</p>
269    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
270    /// <p>The rate exceeds the limit.</p>
271    ThrottlingException(crate::types::error::ThrottlingException),
272    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
273    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
274    variable wildcard pattern and check `.code()`:
275     \
276    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
277     \
278    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-UpdateJobError) for what information is available for the error.")]
279    Unhandled(crate::error::sealed_unhandled::Unhandled),
280}
281impl UpdateJobError {
282    /// Creates the `UpdateJobError::Unhandled` variant from any error type.
283    pub fn unhandled(
284        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
285    ) -> Self {
286        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
287            source: err.into(),
288            meta: ::std::default::Default::default(),
289        })
290    }
291
292    /// Creates the `UpdateJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
293    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
294        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
295            source: err.clone().into(),
296            meta: err,
297        })
298    }
299    ///
300    /// Returns error metadata, which includes the error code, message,
301    /// request ID, and potentially additional information.
302    ///
303    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
304        match self {
305            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
306            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
307            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
308            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
309            Self::Unhandled(e) => &e.meta,
310        }
311    }
312    /// Returns `true` if the error kind is `UpdateJobError::InvalidRequestException`.
313    pub fn is_invalid_request_exception(&self) -> bool {
314        matches!(self, Self::InvalidRequestException(_))
315    }
316    /// Returns `true` if the error kind is `UpdateJobError::ResourceNotFoundException`.
317    pub fn is_resource_not_found_exception(&self) -> bool {
318        matches!(self, Self::ResourceNotFoundException(_))
319    }
320    /// Returns `true` if the error kind is `UpdateJobError::ServiceUnavailableException`.
321    pub fn is_service_unavailable_exception(&self) -> bool {
322        matches!(self, Self::ServiceUnavailableException(_))
323    }
324    /// Returns `true` if the error kind is `UpdateJobError::ThrottlingException`.
325    pub fn is_throttling_exception(&self) -> bool {
326        matches!(self, Self::ThrottlingException(_))
327    }
328}
329impl ::std::error::Error for UpdateJobError {
330    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
331        match self {
332            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
333            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
334            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
335            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
336            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
337        }
338    }
339}
340impl ::std::fmt::Display for UpdateJobError {
341    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
342        match self {
343            Self::InvalidRequestException(_inner) => _inner.fmt(f),
344            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
345            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
346            Self::ThrottlingException(_inner) => _inner.fmt(f),
347            Self::Unhandled(_inner) => {
348                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
349                    write!(f, "unhandled error ({code})")
350                } else {
351                    f.write_str("unhandled error")
352                }
353            }
354        }
355    }
356}
357impl ::aws_smithy_types::retry::ProvideErrorKind for UpdateJobError {
358    fn code(&self) -> ::std::option::Option<&str> {
359        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
360    }
361    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
362        ::std::option::Option::None
363    }
364}
365impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for UpdateJobError {
366    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
367        match self {
368            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
369            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
370            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
371            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
372            Self::Unhandled(_inner) => &_inner.meta,
373        }
374    }
375}
376impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for UpdateJobError {
377    fn create_unhandled_error(
378        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
379        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
380    ) -> Self {
381        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
382            source,
383            meta: meta.unwrap_or_default(),
384        })
385    }
386}
387impl ::aws_types::request_id::RequestId for crate::operation::update_job::UpdateJobError {
388    fn request_id(&self) -> Option<&str> {
389        self.meta().request_id()
390    }
391}
392
393pub use crate::operation::update_job::_update_job_output::UpdateJobOutput;
394
395pub use crate::operation::update_job::_update_job_input::UpdateJobInput;
396
397mod _update_job_input;
398
399mod _update_job_output;
400
401/// Builders
402pub mod builders;