aws_sdk_deadline/operation/
list_steps.rs

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

aws_sdk_deadline/operation/
list_steps.rs
