aws_sdk_deadline/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("deadline", "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                "deadline.ListJobs",
55                "rpc.service" = "deadline",
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", "deadline"));
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::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
123            .with_interceptor(ListJobsEndpointParamsInterceptor)
124            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
125                crate::operation::list_jobs::ListJobsError,
126            >::new())
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
128                crate::operation::list_jobs::ListJobsError,
129            >::new())
130            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
131                crate::operation::list_jobs::ListJobsError,
132            >::new());
133
134        ::std::borrow::Cow::Owned(rcb)
135    }
136}
137
138#[derive(Debug)]
139struct ListJobsResponseDeserializer;
140impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListJobsResponseDeserializer {
141    fn deserialize_nonstreaming(
142        &self,
143        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
144    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
145        let (success, status) = (response.status().is_success(), response.status().as_u16());
146        let headers = response.headers();
147        let body = response.body().bytes().expect("body loaded");
148        #[allow(unused_mut)]
149        let mut force_error = false;
150        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
151        let parse_result = if !success && status != 200 || force_error {
152            crate::protocol_serde::shape_list_jobs::de_list_jobs_http_error(status, headers, body)
153        } else {
154            crate::protocol_serde::shape_list_jobs::de_list_jobs_http_response(status, headers, body)
155        };
156        crate::protocol_serde::type_erase_result(parse_result)
157    }
158}
159#[derive(Debug)]
160struct ListJobsRequestSerializer;
161impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListJobsRequestSerializer {
162    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
163    fn serialize_input(
164        &self,
165        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
166        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
167    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
168        let input = input.downcast::<crate::operation::list_jobs::ListJobsInput>().expect("correct type");
169        let _header_serialization_settings = _cfg
170            .load::<crate::serialization_settings::HeaderSerializationSettings>()
171            .cloned()
172            .unwrap_or_default();
173        let mut request_builder = {
174            #[allow(clippy::uninlined_format_args)]
175            fn uri_base(
176                _input: &crate::operation::list_jobs::ListJobsInput,
177                output: &mut ::std::string::String,
178            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
179                use ::std::fmt::Write as _;
180                let input_1 = &_input.farm_id;
181                let input_1 = input_1
182                    .as_ref()
183                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("farm_id", "cannot be empty or unset"))?;
184                let farm_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
185                if farm_id.is_empty() {
186                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
187                        "farm_id",
188                        "cannot be empty or unset",
189                    ));
190                }
191                let input_2 = &_input.queue_id;
192                let input_2 = input_2
193                    .as_ref()
194                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("queue_id", "cannot be empty or unset"))?;
195                let queue_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
196                if queue_id.is_empty() {
197                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
198                        "queue_id",
199                        "cannot be empty or unset",
200                    ));
201                }
202                ::std::write!(
203                    output,
204                    "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs",
205                    farmId = farm_id,
206                    queueId = queue_id
207                )
208                .expect("formatting should succeed");
209                ::std::result::Result::Ok(())
210            }
211            fn uri_query(
212                _input: &crate::operation::list_jobs::ListJobsInput,
213                mut output: &mut ::std::string::String,
214            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
215                let mut query = ::aws_smithy_http::query::Writer::new(output);
216                if let ::std::option::Option::Some(inner_3) = &_input.principal_id {
217                    {
218                        query.push_kv("principalId", &::aws_smithy_http::query::fmt_string(inner_3));
219                    }
220                }
221                if let ::std::option::Option::Some(inner_4) = &_input.next_token {
222                    {
223                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_4));
224                    }
225                }
226                if let ::std::option::Option::Some(inner_5) = &_input.max_results {
227                    {
228                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_5).encode());
229                    }
230                }
231                ::std::result::Result::Ok(())
232            }
233            #[allow(clippy::unnecessary_wraps)]
234            fn update_http_builder(
235                input: &crate::operation::list_jobs::ListJobsInput,
236                builder: ::http::request::Builder,
237            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
238                let mut uri = ::std::string::String::new();
239                uri_base(input, &mut uri)?;
240                uri_query(input, &mut uri)?;
241                ::std::result::Result::Ok(builder.method("GET").uri(uri))
242            }
243            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
244            builder
245        };
246        let body = ::aws_smithy_types::body::SdkBody::from("");
247
248        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
249    }
250}
251#[derive(Debug)]
252struct ListJobsEndpointParamsInterceptor;
253
254impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListJobsEndpointParamsInterceptor {
255    fn name(&self) -> &'static str {
256        "ListJobsEndpointParamsInterceptor"
257    }
258
259    fn read_before_execution(
260        &self,
261        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
262            '_,
263            ::aws_smithy_runtime_api::client::interceptors::context::Input,
264            ::aws_smithy_runtime_api::client::interceptors::context::Output,
265            ::aws_smithy_runtime_api::client::interceptors::context::Error,
266        >,
267        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
268    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
269        let _input = context
270            .input()
271            .downcast_ref::<ListJobsInput>()
272            .ok_or("failed to downcast to ListJobsInput")?;
273
274        let endpoint_prefix = ::aws_smithy_runtime_api::client::endpoint::EndpointPrefix::new("management.").map_err(|err| {
275            ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint prefix could not be built", err)
276        })?;
277        cfg.interceptor_state().store_put(endpoint_prefix);
278
279        let params = crate::config::endpoint::Params::builder()
280            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
281            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
282            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
283            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
284            .build()
285            .map_err(|err| {
286                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
287            })?;
288        cfg.interceptor_state()
289            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
290        ::std::result::Result::Ok(())
291    }
292}
293
294// The get_* functions below are generated from JMESPath expressions in the
295// operationContextParams trait. They target the operation's input shape.
296
297/// Error type for the `ListJobsError` operation.
298#[non_exhaustive]
299#[derive(::std::fmt::Debug)]
300pub enum ListJobsError {
301    /// <p>You don't have permission to perform the action.</p>
302    AccessDeniedException(crate::types::error::AccessDeniedException),
303    /// <p>Deadline Cloud can't process your request right now. Try again later.</p>
304    InternalServerErrorException(crate::types::error::InternalServerErrorException),
305    /// <p>The requested resource can't be found.</p>
306    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
307    /// <p>Your request exceeded a request rate quota.</p>
308    ThrottlingException(crate::types::error::ThrottlingException),
309    /// <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
310    ValidationException(crate::types::error::ValidationException),
311    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
312    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
313    variable wildcard pattern and check `.code()`:
314     \
315    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
316     \
317    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListJobsError) for what information is available for the error.")]
318    Unhandled(crate::error::sealed_unhandled::Unhandled),
319}
320impl ListJobsError {
321    /// Creates the `ListJobsError::Unhandled` variant from any error type.
322    pub fn unhandled(
323        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
324    ) -> Self {
325        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
326            source: err.into(),
327            meta: ::std::default::Default::default(),
328        })
329    }
330
331    /// Creates the `ListJobsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
332    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
333        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
334            source: err.clone().into(),
335            meta: err,
336        })
337    }
338    ///
339    /// Returns error metadata, which includes the error code, message,
340    /// request ID, and potentially additional information.
341    ///
342    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
343        match self {
344            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
345            Self::InternalServerErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
346            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
347            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
348            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
349            Self::Unhandled(e) => &e.meta,
350        }
351    }
352    /// Returns `true` if the error kind is `ListJobsError::AccessDeniedException`.
353    pub fn is_access_denied_exception(&self) -> bool {
354        matches!(self, Self::AccessDeniedException(_))
355    }
356    /// Returns `true` if the error kind is `ListJobsError::InternalServerErrorException`.
357    pub fn is_internal_server_error_exception(&self) -> bool {
358        matches!(self, Self::InternalServerErrorException(_))
359    }
360    /// Returns `true` if the error kind is `ListJobsError::ResourceNotFoundException`.
361    pub fn is_resource_not_found_exception(&self) -> bool {
362        matches!(self, Self::ResourceNotFoundException(_))
363    }
364    /// Returns `true` if the error kind is `ListJobsError::ThrottlingException`.
365    pub fn is_throttling_exception(&self) -> bool {
366        matches!(self, Self::ThrottlingException(_))
367    }
368    /// Returns `true` if the error kind is `ListJobsError::ValidationException`.
369    pub fn is_validation_exception(&self) -> bool {
370        matches!(self, Self::ValidationException(_))
371    }
372}
373impl ::std::error::Error for ListJobsError {
374    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
375        match self {
376            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
377            Self::InternalServerErrorException(_inner) => ::std::option::Option::Some(_inner),
378            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
379            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
380            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
381            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
382        }
383    }
384}
385impl ::std::fmt::Display for ListJobsError {
386    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
387        match self {
388            Self::AccessDeniedException(_inner) => _inner.fmt(f),
389            Self::InternalServerErrorException(_inner) => _inner.fmt(f),
390            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
391            Self::ThrottlingException(_inner) => _inner.fmt(f),
392            Self::ValidationException(_inner) => _inner.fmt(f),
393            Self::Unhandled(_inner) => {
394                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
395                    write!(f, "unhandled error ({code})")
396                } else {
397                    f.write_str("unhandled error")
398                }
399            }
400        }
401    }
402}
403impl ::aws_smithy_types::retry::ProvideErrorKind for ListJobsError {
404    fn code(&self) -> ::std::option::Option<&str> {
405        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
406    }
407    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
408        match self {
409            Self::InternalServerErrorException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
410            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
411            _ => ::std::option::Option::None,
412        }
413    }
414}
415impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListJobsError {
416    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
417        match self {
418            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
419            Self::InternalServerErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
420            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
421            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
422            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
423            Self::Unhandled(_inner) => &_inner.meta,
424        }
425    }
426}
427impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListJobsError {
428    fn create_unhandled_error(
429        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
430        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
431    ) -> Self {
432        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
433            source,
434            meta: meta.unwrap_or_default(),
435        })
436    }
437}
438impl ::aws_types::request_id::RequestId for crate::operation::list_jobs::ListJobsError {
439    fn request_id(&self) -> Option<&str> {
440        self.meta().request_id()
441    }
442}
443
444pub use crate::operation::list_jobs::_list_jobs_output::ListJobsOutput;
445
446pub use crate::operation::list_jobs::_list_jobs_input::ListJobsInput;
447
448mod _list_jobs_input;
449
450mod _list_jobs_output;
451
452/// Builders
453pub mod builders;
454
455/// Paginator for this operation
456pub mod paginator;
aws_sdk_deadline/operation/list_jobs.rs

aws_sdk_deadline/operation/
list_jobs.rs
