aws_sdk_deadline/operation/
list_queue_environments.rs

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