Skip to main content

aws_sdk_endusermessaging/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("EndUserMessaging", "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                "EndUserMessaging.ListJobs",
55                "rpc.service" = "EndUserMessaging",
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(
102            "ListJobs",
103            "EndUserMessaging",
104        ));
105        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
106        signing_options.double_uri_encode = true;
107        signing_options.content_sha256_header = false;
108        signing_options.normalize_uri_path = true;
109        signing_options.payload_override = None;
110
111        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
112            signing_options,
113            ..::std::default::Default::default()
114        });
115
116        ::std::option::Option::Some(cfg.freeze())
117    }
118
119    fn runtime_components(
120        &self,
121        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
122    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
123        #[allow(unused_mut)]
124        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListJobs")
125            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
126                ListJobsTelemetryInputCaptureInterceptor,
127            ))
128            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
129                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
130            ))
131            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
132                ListJobsEndpointParamsInterceptor,
133            ))
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
135                crate::operation::list_jobs::ListJobsError,
136            >::new())
137            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
138                crate::operation::list_jobs::ListJobsError,
139            >::new())
140            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
141                crate::operation::list_jobs::ListJobsError,
142            >::new())
143            .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
144                crate::operation::list_jobs::ListJobsError,
145            >::new());
146
147        ::std::borrow::Cow::Owned(rcb)
148    }
149}
150
151#[derive(Debug)]
152struct ListJobsTelemetryInputCaptureInterceptor;
153
154#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
155impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListJobsTelemetryInputCaptureInterceptor {
156    fn name(&self) -> &'static str {
157        "ListJobsTelemetryInputCaptureInterceptor"
158    }
159
160    fn read_before_execution(
161        &self,
162        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
163            '_,
164            ::aws_smithy_runtime_api::client::interceptors::context::Input,
165            ::aws_smithy_runtime_api::client::interceptors::context::Output,
166            ::aws_smithy_runtime_api::client::interceptors::context::Error,
167        >,
168        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
169    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
170        // Nothing to do unless the customer opted in by naming members to record.
171        let ::std::option::Option::Some(requested) = cfg
172            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
173            .filter(|r| !r.is_empty())
174        else {
175            return ::std::result::Result::Ok(());
176        };
177
178        let ::std::option::Option::Some(input) = context.input().downcast_ref::<ListJobsInput>() else {
179            // A mismatched input is not this interceptor's concern; skip quietly.
180            return ::std::result::Result::Ok(());
181        };
182
183        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
184        if requested.should_capture("nextToken") {
185            if let ::std::option::Option::Some(value) = input.next_token.as_deref() {
186                captured.insert("nextToken", value);
187            }
188        }
189        if requested.should_capture("brandProfileId") {
190            if let ::std::option::Option::Some(value) = input.brand_profile_id.as_deref() {
191                captured.insert("brandProfileId", value);
192            }
193        }
194        if requested.should_capture("operationType") {
195            if let ::std::option::Option::Some(value) = input.operation_type.as_deref() {
196                captured.insert("operationType", value);
197            }
198        }
199
200        cfg.interceptor_state().store_put(captured);
201        ::std::result::Result::Ok(())
202    }
203}
204#[derive(Debug)]
205struct ListJobsResponseDeserializer;
206impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListJobsResponseDeserializer {
207    fn deserialize_nonstreaming_with_config(
208        &self,
209        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
210        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
211    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
212        let (success, status) = (response.status().is_success(), response.status().as_u16());
213        let headers = response.headers();
214        let body = response.body().bytes().expect("body loaded");
215        #[allow(unused_mut)]
216        let mut force_error = false;
217        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
218        let parse_result = if !success && status != 200 || force_error {
219            crate::protocol_serde::shape_list_jobs::de_list_jobs_http_error(status, headers, body, _cfg)
220        } else {
221            crate::protocol_serde::shape_list_jobs::de_list_jobs_http_response(status, headers, body, _cfg)
222        };
223        crate::protocol_serde::type_erase_result(parse_result)
224    }
225}
226#[derive(Debug)]
227struct ListJobsRequestSerializer;
228impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListJobsRequestSerializer {
229    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
230    fn serialize_input(
231        &self,
232        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
233        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
234    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
235        let input = input.downcast::<crate::operation::list_jobs::ListJobsInput>().expect("correct type");
236        let _header_serialization_settings = _cfg
237            .load::<crate::serialization_settings::HeaderSerializationSettings>()
238            .cloned()
239            .unwrap_or_default();
240        let mut request_builder = {
241            #[allow(clippy::uninlined_format_args)]
242            fn uri_base(
243                _input: &crate::operation::list_jobs::ListJobsInput,
244                output: &mut ::std::string::String,
245            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
246                use ::std::fmt::Write as _;
247                ::std::write!(output, "/v1/jobs").expect("formatting should succeed");
248                ::std::result::Result::Ok(())
249            }
250            fn uri_query(
251                _input: &crate::operation::list_jobs::ListJobsInput,
252                mut output: &mut ::std::string::String,
253            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
254                let mut query = ::aws_smithy_http::query::Writer::new(output);
255                if let ::std::option::Option::Some(inner_1) = &_input.max_results {
256                    {
257                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_1).encode());
258                    }
259                }
260                if let ::std::option::Option::Some(inner_2) = &_input.next_token {
261                    {
262                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_2));
263                    }
264                }
265                if let ::std::option::Option::Some(inner_3) = &_input.status {
266                    {
267                        query.push_kv("status", &::aws_smithy_http::query::fmt_string(inner_3.as_str()));
268                    }
269                }
270                if let ::std::option::Option::Some(inner_4) = &_input.brand_profile_id {
271                    {
272                        query.push_kv("brandProfileId", &::aws_smithy_http::query::fmt_string(inner_4));
273                    }
274                }
275                if let ::std::option::Option::Some(inner_5) = &_input.operation_type {
276                    {
277                        query.push_kv("operationType", &::aws_smithy_http::query::fmt_string(inner_5));
278                    }
279                }
280                ::std::result::Result::Ok(())
281            }
282            #[allow(clippy::unnecessary_wraps)]
283            fn update_http_builder(
284                input: &crate::operation::list_jobs::ListJobsInput,
285                builder: ::http_1x::request::Builder,
286            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
287                let mut uri = ::std::string::String::new();
288                uri_base(input, &mut uri)?;
289                uri_query(input, &mut uri)?;
290                ::std::result::Result::Ok(builder.method("GET").uri(uri))
291            }
292            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
293            builder
294        };
295        let body = ::aws_smithy_types::body::SdkBody::from("");
296
297        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
298    }
299}
300#[derive(Debug)]
301struct ListJobsEndpointParamsInterceptor;
302
303#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
304impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListJobsEndpointParamsInterceptor {
305    fn name(&self) -> &'static str {
306        "ListJobsEndpointParamsInterceptor"
307    }
308
309    fn read_before_execution(
310        &self,
311        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
312            '_,
313            ::aws_smithy_runtime_api::client::interceptors::context::Input,
314            ::aws_smithy_runtime_api::client::interceptors::context::Output,
315            ::aws_smithy_runtime_api::client::interceptors::context::Error,
316        >,
317        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
318    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
319        let _input = context
320            .input()
321            .downcast_ref::<ListJobsInput>()
322            .ok_or("failed to downcast to ListJobsInput")?;
323
324        let params = crate::config::endpoint::Params::builder()
325            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
326            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
327            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
328            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
329            .build()
330            .map_err(|err| {
331                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
332            })?;
333        cfg.interceptor_state()
334            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
335        ::std::result::Result::Ok(())
336    }
337}
338
339// The get_* functions below are generated from JMESPath expressions in the
340// operationContextParams trait. They target the operation's input shape.
341
342/// Error type for the `ListJobsError` operation.
343#[non_exhaustive]
344#[derive(::std::fmt::Debug)]
345pub enum ListJobsError {
346    /// <p>You do not have sufficient access to perform this action.</p>
347    AccessDeniedException(crate::types::error::AccessDeniedException),
348    /// <p>An unexpected error occurred during the processing of the request.</p>
349    InternalServerException(crate::types::error::InternalServerException),
350    /// <p>The request was denied because it exceeded the allowed request rate.</p>
351    ThrottlingException(crate::types::error::ThrottlingException),
352    /// A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
353    ValidationException(crate::types::error::ValidationException),
354    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
355    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
356    variable wildcard pattern and check `.code()`:
357     \
358    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
359     \
360    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListJobsError) for what information is available for the error.")]
361    Unhandled(crate::error::sealed_unhandled::Unhandled),
362}
363impl ListJobsError {
364    /// Creates the `ListJobsError::Unhandled` variant from any error type.
365    pub fn unhandled(
366        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
367    ) -> Self {
368        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
369            source: err.into(),
370            meta: ::std::default::Default::default(),
371        })
372    }
373
374    /// Creates the `ListJobsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
375    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
376        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
377            source: err.clone().into(),
378            meta: err,
379        })
380    }
381    ///
382    /// Returns error metadata, which includes the error code, message,
383    /// request ID, and potentially additional information.
384    ///
385    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
386        match self {
387            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
388            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
389            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
390            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
391            Self::Unhandled(e) => &e.meta,
392        }
393    }
394    /// Returns `true` if the error kind is `ListJobsError::AccessDeniedException`.
395    pub fn is_access_denied_exception(&self) -> bool {
396        matches!(self, Self::AccessDeniedException(_))
397    }
398    /// Returns `true` if the error kind is `ListJobsError::InternalServerException`.
399    pub fn is_internal_server_exception(&self) -> bool {
400        matches!(self, Self::InternalServerException(_))
401    }
402    /// Returns `true` if the error kind is `ListJobsError::ThrottlingException`.
403    pub fn is_throttling_exception(&self) -> bool {
404        matches!(self, Self::ThrottlingException(_))
405    }
406    /// Returns `true` if the error kind is `ListJobsError::ValidationException`.
407    pub fn is_validation_exception(&self) -> bool {
408        matches!(self, Self::ValidationException(_))
409    }
410}
411impl ::std::error::Error for ListJobsError {
412    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
413        match self {
414            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
415            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
416            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
417            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
418            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
419        }
420    }
421}
422impl ::std::fmt::Display for ListJobsError {
423    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
424        match self {
425            Self::AccessDeniedException(_inner) => _inner.fmt(f),
426            Self::InternalServerException(_inner) => _inner.fmt(f),
427            Self::ThrottlingException(_inner) => _inner.fmt(f),
428            Self::ValidationException(_inner) => _inner.fmt(f),
429            Self::Unhandled(_inner) => {
430                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
431                    write!(f, "unhandled error ({code})")
432                } else {
433                    f.write_str("unhandled error")
434                }
435            }
436        }
437    }
438}
439impl ::aws_smithy_types::retry::ProvideErrorKind for ListJobsError {
440    fn code(&self) -> ::std::option::Option<&str> {
441        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
442    }
443    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
444        match self {
445            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
446            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
447            _ => ::std::option::Option::None,
448        }
449    }
450}
451impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListJobsError {
452    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
453        match self {
454            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
455            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
456            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
457            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
458            Self::Unhandled(_inner) => &_inner.meta,
459        }
460    }
461}
462impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListJobsError {
463    fn create_unhandled_error(
464        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
465        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
466    ) -> Self {
467        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
468            source,
469            meta: meta.unwrap_or_default(),
470        })
471    }
472}
473impl ::aws_types::request_id::RequestId for crate::operation::list_jobs::ListJobsError {
474    fn request_id(&self) -> Option<&str> {
475        self.meta().request_id()
476    }
477}
478
479pub use crate::operation::list_jobs::_list_jobs_input::ListJobsInput;
480
481pub use crate::operation::list_jobs::_list_jobs_output::ListJobsOutput;
482
483mod _list_jobs_input;
484
485mod _list_jobs_output;
486
487/// Builders
488pub mod builders;
489
490/// Paginator for this operation
491pub mod paginator;