aws_sdk_iot/operation/
list_jobs.rs

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

aws_sdk_iot/operation/
list_jobs.rs
