Skip to main content

aws_sdk_iotmanagedintegrations/operation/
get_ota_task.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetOtaTask`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetOtaTask;
6impl GetOtaTask {
7    /// Creates a new `GetOtaTask`
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::get_ota_task::GetOtaTaskInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_ota_task::GetOtaTaskOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_ota_task::GetOtaTaskError,
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_ota_task::GetOtaTaskError>()
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_ota_task::GetOtaTaskOutput>()
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_ota_task::GetOtaTaskInput,
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(
55            "IoT Managed Integrations",
56            "GetOtaTask",
57            input,
58            runtime_plugins,
59            stop_point,
60        )
61        // Create a parent span for the entire operation. Includes a random, internal-only,
62        // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
63        .instrument(::tracing::debug_span!(
64            "IoT Managed Integrations.GetOtaTask",
65            "rpc.service" = "IoT Managed Integrations",
66            "rpc.method" = "GetOtaTask",
67            "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
68            "rpc.system" = "aws-api",
69        ))
70        .await
71    }
72
73    pub(crate) fn operation_runtime_plugins(
74        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
75        client_config: &crate::config::Config,
76        config_override: ::std::option::Option<crate::config::Builder>,
77    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
78        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
79
80        if let ::std::option::Option::Some(config_override) = config_override {
81            for plugin in config_override.runtime_plugins.iter().cloned() {
82                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
83            }
84            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
85                config_override,
86                client_config.config.clone(),
87                &client_config.runtime_components,
88            ));
89        }
90        runtime_plugins
91    }
92}
93impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetOtaTask {
94    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
95        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetOtaTask");
96
97        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
98            GetOtaTaskRequestSerializer,
99        ));
100        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
101            GetOtaTaskResponseDeserializer,
102        ));
103
104        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
105            crate::config::auth::Params::builder()
106                .operation_name("GetOtaTask")
107                .build()
108                .expect("required fields set"),
109        ));
110
111        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
112        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
113            "GetOtaTask",
114            "IoT Managed Integrations",
115        ));
116        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
117        signing_options.double_uri_encode = true;
118        signing_options.content_sha256_header = false;
119        signing_options.normalize_uri_path = true;
120        signing_options.payload_override = None;
121
122        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
123            signing_options,
124            ..::std::default::Default::default()
125        });
126
127        ::std::option::Option::Some(cfg.freeze())
128    }
129
130    fn runtime_components(
131        &self,
132        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
133    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
134        #[allow(unused_mut)]
135        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetOtaTask")
136            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
137                GetOtaTaskTelemetryInputCaptureInterceptor,
138            ))
139            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
140                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
141            ))
142            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
143                GetOtaTaskEndpointParamsInterceptor,
144            ))
145            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
146                crate::operation::get_ota_task::GetOtaTaskError,
147            >::new())
148            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
149                crate::operation::get_ota_task::GetOtaTaskError,
150            >::new())
151            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
152                crate::operation::get_ota_task::GetOtaTaskError,
153            >::new());
154
155        ::std::borrow::Cow::Owned(rcb)
156    }
157}
158
159#[derive(Debug)]
160struct GetOtaTaskTelemetryInputCaptureInterceptor;
161
162#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
163impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetOtaTaskTelemetryInputCaptureInterceptor {
164    fn name(&self) -> &'static str {
165        "GetOtaTaskTelemetryInputCaptureInterceptor"
166    }
167
168    fn read_before_execution(
169        &self,
170        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
171            '_,
172            ::aws_smithy_runtime_api::client::interceptors::context::Input,
173            ::aws_smithy_runtime_api::client::interceptors::context::Output,
174            ::aws_smithy_runtime_api::client::interceptors::context::Error,
175        >,
176        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
177    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
178        // Nothing to do unless the customer opted in by naming members to record.
179        let ::std::option::Option::Some(requested) = cfg
180            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
181            .filter(|r| !r.is_empty())
182        else {
183            return ::std::result::Result::Ok(());
184        };
185
186        let ::std::option::Option::Some(input) = context.input().downcast_ref::<GetOtaTaskInput>() else {
187            // A mismatched input is not this interceptor's concern; skip quietly.
188            return ::std::result::Result::Ok(());
189        };
190
191        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
192        if requested.should_capture("Identifier") {
193            if let ::std::option::Option::Some(value) = input.identifier.as_deref() {
194                captured.insert("Identifier", value);
195            }
196        }
197
198        cfg.interceptor_state().store_put(captured);
199        ::std::result::Result::Ok(())
200    }
201}
202#[derive(Debug)]
203struct GetOtaTaskResponseDeserializer;
204impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetOtaTaskResponseDeserializer {
205    fn deserialize_nonstreaming_with_config(
206        &self,
207        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
208        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
209    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
210        let (success, status) = (response.status().is_success(), response.status().as_u16());
211        let headers = response.headers();
212        let body = response.body().bytes().expect("body loaded");
213        #[allow(unused_mut)]
214        let mut force_error = false;
215        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
216        let parse_result = if !success && status != 200 || force_error {
217            crate::protocol_serde::shape_get_ota_task::de_get_ota_task_http_error(status, headers, body)
218        } else {
219            crate::protocol_serde::shape_get_ota_task::de_get_ota_task_http_response(status, headers, body)
220        };
221        crate::protocol_serde::type_erase_result(parse_result)
222    }
223}
224#[derive(Debug)]
225struct GetOtaTaskRequestSerializer;
226impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetOtaTaskRequestSerializer {
227    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
228    fn serialize_input(
229        &self,
230        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
231        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
232    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
233        let input = input.downcast::<crate::operation::get_ota_task::GetOtaTaskInput>().expect("correct type");
234        let _header_serialization_settings = _cfg
235            .load::<crate::serialization_settings::HeaderSerializationSettings>()
236            .cloned()
237            .unwrap_or_default();
238        let mut request_builder = {
239            #[allow(clippy::uninlined_format_args)]
240            fn uri_base(
241                _input: &crate::operation::get_ota_task::GetOtaTaskInput,
242                output: &mut ::std::string::String,
243            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
244                use ::std::fmt::Write as _;
245                let input_1 = &_input.identifier;
246                let input_1 = input_1
247                    .as_ref()
248                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("identifier", "cannot be empty or unset"))?;
249                let identifier = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
250                if identifier.is_empty() {
251                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
252                        "identifier",
253                        "cannot be empty or unset",
254                    ));
255                }
256                ::std::write!(output, "/ota-tasks/{Identifier}", Identifier = identifier).expect("formatting should succeed");
257                ::std::result::Result::Ok(())
258            }
259            #[allow(clippy::unnecessary_wraps)]
260            fn update_http_builder(
261                input: &crate::operation::get_ota_task::GetOtaTaskInput,
262                builder: ::http_1x::request::Builder,
263            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
264                let mut uri = ::std::string::String::new();
265                uri_base(input, &mut uri)?;
266                ::std::result::Result::Ok(builder.method("GET").uri(uri))
267            }
268            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
269            builder
270        };
271        let body = ::aws_smithy_types::body::SdkBody::from("");
272
273        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
274    }
275}
276#[derive(Debug)]
277struct GetOtaTaskEndpointParamsInterceptor;
278
279#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
280impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetOtaTaskEndpointParamsInterceptor {
281    fn name(&self) -> &'static str {
282        "GetOtaTaskEndpointParamsInterceptor"
283    }
284
285    fn read_before_execution(
286        &self,
287        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
288            '_,
289            ::aws_smithy_runtime_api::client::interceptors::context::Input,
290            ::aws_smithy_runtime_api::client::interceptors::context::Output,
291            ::aws_smithy_runtime_api::client::interceptors::context::Error,
292        >,
293        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
294    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
295        let _input = context
296            .input()
297            .downcast_ref::<GetOtaTaskInput>()
298            .ok_or("failed to downcast to GetOtaTaskInput")?;
299
300        let params = crate::config::endpoint::Params::builder()
301            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
302            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
303            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
304            .build()
305            .map_err(|err| {
306                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
307            })?;
308        cfg.interceptor_state()
309            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
310        ::std::result::Result::Ok(())
311    }
312}
313
314// The get_* functions below are generated from JMESPath expressions in the
315// operationContextParams trait. They target the operation's input shape.
316
317/// Error type for the `GetOtaTaskError` operation.
318#[non_exhaustive]
319#[derive(::std::fmt::Debug)]
320pub enum GetOtaTaskError {
321    /// <p>User is not authorized.</p>
322    AccessDeniedException(crate::types::error::AccessDeniedException),
323    /// <p>Internal error from the service that indicates an unexpected error or that the service is unavailable.</p>
324    InternalServerException(crate::types::error::InternalServerException),
325    /// <p>The specified resource does not exist.</p>
326    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
327    /// <p>The rate exceeds the limit.</p>
328    ThrottlingException(crate::types::error::ThrottlingException),
329    /// <p>A validation error occurred when performing the API request.</p>
330    ValidationException(crate::types::error::ValidationException),
331    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
332    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
333    variable wildcard pattern and check `.code()`:
334     \
335    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
336     \
337    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetOtaTaskError) for what information is available for the error.")]
338    Unhandled(crate::error::sealed_unhandled::Unhandled),
339}
340impl GetOtaTaskError {
341    /// Creates the `GetOtaTaskError::Unhandled` variant from any error type.
342    pub fn unhandled(
343        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
344    ) -> Self {
345        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
346            source: err.into(),
347            meta: ::std::default::Default::default(),
348        })
349    }
350
351    /// Creates the `GetOtaTaskError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
352    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
353        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
354            source: err.clone().into(),
355            meta: err,
356        })
357    }
358    ///
359    /// Returns error metadata, which includes the error code, message,
360    /// request ID, and potentially additional information.
361    ///
362    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
363        match self {
364            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
365            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
366            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
367            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
368            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
369            Self::Unhandled(e) => &e.meta,
370        }
371    }
372    /// Returns `true` if the error kind is `GetOtaTaskError::AccessDeniedException`.
373    pub fn is_access_denied_exception(&self) -> bool {
374        matches!(self, Self::AccessDeniedException(_))
375    }
376    /// Returns `true` if the error kind is `GetOtaTaskError::InternalServerException`.
377    pub fn is_internal_server_exception(&self) -> bool {
378        matches!(self, Self::InternalServerException(_))
379    }
380    /// Returns `true` if the error kind is `GetOtaTaskError::ResourceNotFoundException`.
381    pub fn is_resource_not_found_exception(&self) -> bool {
382        matches!(self, Self::ResourceNotFoundException(_))
383    }
384    /// Returns `true` if the error kind is `GetOtaTaskError::ThrottlingException`.
385    pub fn is_throttling_exception(&self) -> bool {
386        matches!(self, Self::ThrottlingException(_))
387    }
388    /// Returns `true` if the error kind is `GetOtaTaskError::ValidationException`.
389    pub fn is_validation_exception(&self) -> bool {
390        matches!(self, Self::ValidationException(_))
391    }
392}
393impl ::std::error::Error for GetOtaTaskError {
394    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
395        match self {
396            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
397            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
398            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
399            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
400            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
401            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
402        }
403    }
404}
405impl ::std::fmt::Display for GetOtaTaskError {
406    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
407        match self {
408            Self::AccessDeniedException(_inner) => _inner.fmt(f),
409            Self::InternalServerException(_inner) => _inner.fmt(f),
410            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
411            Self::ThrottlingException(_inner) => _inner.fmt(f),
412            Self::ValidationException(_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 GetOtaTaskError {
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 GetOtaTaskError {
432    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
433        match self {
434            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
435            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
436            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
437            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
438            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
439            Self::Unhandled(_inner) => &_inner.meta,
440        }
441    }
442}
443impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetOtaTaskError {
444    fn create_unhandled_error(
445        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
446        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
447    ) -> Self {
448        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
449            source,
450            meta: meta.unwrap_or_default(),
451        })
452    }
453}
454impl ::aws_types::request_id::RequestId for crate::operation::get_ota_task::GetOtaTaskError {
455    fn request_id(&self) -> Option<&str> {
456        self.meta().request_id()
457    }
458}
459
460pub use crate::operation::get_ota_task::_get_ota_task_input::GetOtaTaskInput;
461
462pub use crate::operation::get_ota_task::_get_ota_task_output::GetOtaTaskOutput;
463
464mod _get_ota_task_input;
465
466mod _get_ota_task_output;
467
468/// Builders
469pub mod builders;