aws_sdk_iot/operation/
describe_job.rs

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

aws_sdk_iot/operation/
describe_job.rs
