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

aws_sdk_iot/operation/
list_jobs.rs
