aws_sdk_m2/operation/
list_environments.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListEnvironments`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListEnvironments;
6impl ListEnvironments {
7    /// Creates a new `ListEnvironments`
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_environments::ListEnvironmentsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_environments::ListEnvironmentsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_environments::ListEnvironmentsError,
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_environments::ListEnvironmentsError>()
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_environments::ListEnvironmentsOutput>()
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_environments::ListEnvironmentsInput,
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("m2", "ListEnvironments", 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                "m2.ListEnvironments",
59                "rpc.service" = "m2",
60                "rpc.method" = "ListEnvironments",
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 ListEnvironments {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListEnvironments");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListEnvironmentsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListEnvironmentsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListEnvironments")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListEnvironments", "m2"));
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("ListEnvironments")
126            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
127                ListEnvironmentsTelemetryInputCaptureInterceptor,
128            ))
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                ListEnvironmentsEndpointParamsInterceptor,
134            ))
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136                crate::operation::list_environments::ListEnvironmentsError,
137            >::new())
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139                crate::operation::list_environments::ListEnvironmentsError,
140            >::new())
141            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
142                crate::operation::list_environments::ListEnvironmentsError,
143            >::new());
144
145        ::std::borrow::Cow::Owned(rcb)
146    }
147}
148
149#[derive(Debug)]
150struct ListEnvironmentsTelemetryInputCaptureInterceptor;
151
152#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
153impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListEnvironmentsTelemetryInputCaptureInterceptor {
154    fn name(&self) -> &'static str {
155        "ListEnvironmentsTelemetryInputCaptureInterceptor"
156    }
157
158    fn read_before_execution(
159        &self,
160        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
161            '_,
162            ::aws_smithy_runtime_api::client::interceptors::context::Input,
163            ::aws_smithy_runtime_api::client::interceptors::context::Output,
164            ::aws_smithy_runtime_api::client::interceptors::context::Error,
165        >,
166        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
167    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
168        // Nothing to do unless the customer opted in by naming members to record.
169        let ::std::option::Option::Some(requested) = cfg
170            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
171            .filter(|r| !r.is_empty())
172        else {
173            return ::std::result::Result::Ok(());
174        };
175
176        let ::std::option::Option::Some(input) = context.input().downcast_ref::<ListEnvironmentsInput>() else {
177            // A mismatched input is not this interceptor's concern; skip quietly.
178            return ::std::result::Result::Ok(());
179        };
180
181        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
182        if requested.should_capture("nextToken") {
183            if let ::std::option::Option::Some(value) = input.next_token.as_deref() {
184                captured.insert("nextToken", value);
185            }
186        }
187
188        cfg.interceptor_state().store_put(captured);
189        ::std::result::Result::Ok(())
190    }
191}
192#[derive(Debug)]
193struct ListEnvironmentsResponseDeserializer;
194impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListEnvironmentsResponseDeserializer {
195    fn deserialize_nonstreaming_with_config(
196        &self,
197        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
198        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
199    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
200        let (success, status) = (response.status().is_success(), response.status().as_u16());
201        let headers = response.headers();
202        let body = response.body().bytes().expect("body loaded");
203        #[allow(unused_mut)]
204        let mut force_error = false;
205        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
206        let parse_result = if !success && status != 200 || force_error {
207            crate::protocol_serde::shape_list_environments::de_list_environments_http_error(status, headers, body)
208        } else {
209            crate::protocol_serde::shape_list_environments::de_list_environments_http_response(status, headers, body)
210        };
211        crate::protocol_serde::type_erase_result(parse_result)
212    }
213}
214#[derive(Debug)]
215struct ListEnvironmentsRequestSerializer;
216impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListEnvironmentsRequestSerializer {
217    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
218    fn serialize_input(
219        &self,
220        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
221        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
222    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
223        let input = input
224            .downcast::<crate::operation::list_environments::ListEnvironmentsInput>()
225            .expect("correct type");
226        let _header_serialization_settings = _cfg
227            .load::<crate::serialization_settings::HeaderSerializationSettings>()
228            .cloned()
229            .unwrap_or_default();
230        let mut request_builder = {
231            #[allow(clippy::uninlined_format_args)]
232            fn uri_base(
233                _input: &crate::operation::list_environments::ListEnvironmentsInput,
234                output: &mut ::std::string::String,
235            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
236                use ::std::fmt::Write as _;
237                ::std::write!(output, "/environments").expect("formatting should succeed");
238                ::std::result::Result::Ok(())
239            }
240            fn uri_query(
241                _input: &crate::operation::list_environments::ListEnvironmentsInput,
242                mut output: &mut ::std::string::String,
243            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
244                let mut query = ::aws_smithy_http::query::Writer::new(output);
245                if let ::std::option::Option::Some(inner_1) = &_input.next_token {
246                    {
247                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_1));
248                    }
249                }
250                if let ::std::option::Option::Some(inner_2) = &_input.max_results {
251                    {
252                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
253                    }
254                }
255                if let ::std::option::Option::Some(inner_3) = &_input.names {
256                    {
257                        for inner_4 in inner_3 {
258                            query.push_kv("names", &::aws_smithy_http::query::fmt_string(inner_4));
259                        }
260                    }
261                }
262                if let ::std::option::Option::Some(inner_5) = &_input.engine_type {
263                    {
264                        query.push_kv("engineType", &::aws_smithy_http::query::fmt_string(inner_5.as_str()));
265                    }
266                }
267                ::std::result::Result::Ok(())
268            }
269            #[allow(clippy::unnecessary_wraps)]
270            fn update_http_builder(
271                input: &crate::operation::list_environments::ListEnvironmentsInput,
272                builder: ::http_1x::request::Builder,
273            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
274                let mut uri = ::std::string::String::new();
275                uri_base(input, &mut uri)?;
276                uri_query(input, &mut uri)?;
277                ::std::result::Result::Ok(builder.method("GET").uri(uri))
278            }
279            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
280            builder
281        };
282        let body = ::aws_smithy_types::body::SdkBody::from("");
283
284        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
285    }
286}
287#[derive(Debug)]
288struct ListEnvironmentsEndpointParamsInterceptor;
289
290#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
291impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListEnvironmentsEndpointParamsInterceptor {
292    fn name(&self) -> &'static str {
293        "ListEnvironmentsEndpointParamsInterceptor"
294    }
295
296    fn read_before_execution(
297        &self,
298        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
299            '_,
300            ::aws_smithy_runtime_api::client::interceptors::context::Input,
301            ::aws_smithy_runtime_api::client::interceptors::context::Output,
302            ::aws_smithy_runtime_api::client::interceptors::context::Error,
303        >,
304        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
305    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
306        let _input = context
307            .input()
308            .downcast_ref::<ListEnvironmentsInput>()
309            .ok_or("failed to downcast to ListEnvironmentsInput")?;
310
311        let params = crate::config::endpoint::Params::builder()
312            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
313            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
314            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
315            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
316            .build()
317            .map_err(|err| {
318                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
319            })?;
320        cfg.interceptor_state()
321            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
322        ::std::result::Result::Ok(())
323    }
324}
325
326// The get_* functions below are generated from JMESPath expressions in the
327// operationContextParams trait. They target the operation's input shape.
328
329/// Error type for the `ListEnvironmentsError` operation.
330#[non_exhaustive]
331#[derive(::std::fmt::Debug)]
332pub enum ListEnvironmentsError {
333    /// <p>The account or role doesn't have the right permissions to make the request.</p>
334    AccessDeniedException(crate::types::error::AccessDeniedException),
335    /// <p>An unexpected error occurred during the processing of the request.</p>
336    InternalServerException(crate::types::error::InternalServerException),
337    /// <p>The number of requests made exceeds the limit.</p>
338    ThrottlingException(crate::types::error::ThrottlingException),
339    /// <p>One or more parameters provided in the request is not valid.</p>
340    ValidationException(crate::types::error::ValidationException),
341    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
342    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
343    variable wildcard pattern and check `.code()`:
344     \
345    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
346     \
347    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListEnvironmentsError) for what information is available for the error.")]
348    Unhandled(crate::error::sealed_unhandled::Unhandled),
349}
350impl ListEnvironmentsError {
351    /// Creates the `ListEnvironmentsError::Unhandled` variant from any error type.
352    pub fn unhandled(
353        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
354    ) -> Self {
355        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
356            source: err.into(),
357            meta: ::std::default::Default::default(),
358        })
359    }
360
361    /// Creates the `ListEnvironmentsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
362    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
363        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
364            source: err.clone().into(),
365            meta: err,
366        })
367    }
368    ///
369    /// Returns error metadata, which includes the error code, message,
370    /// request ID, and potentially additional information.
371    ///
372    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
373        match self {
374            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
375            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
376            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
377            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
378            Self::Unhandled(e) => &e.meta,
379        }
380    }
381    /// Returns `true` if the error kind is `ListEnvironmentsError::AccessDeniedException`.
382    pub fn is_access_denied_exception(&self) -> bool {
383        matches!(self, Self::AccessDeniedException(_))
384    }
385    /// Returns `true` if the error kind is `ListEnvironmentsError::InternalServerException`.
386    pub fn is_internal_server_exception(&self) -> bool {
387        matches!(self, Self::InternalServerException(_))
388    }
389    /// Returns `true` if the error kind is `ListEnvironmentsError::ThrottlingException`.
390    pub fn is_throttling_exception(&self) -> bool {
391        matches!(self, Self::ThrottlingException(_))
392    }
393    /// Returns `true` if the error kind is `ListEnvironmentsError::ValidationException`.
394    pub fn is_validation_exception(&self) -> bool {
395        matches!(self, Self::ValidationException(_))
396    }
397}
398impl ::std::error::Error for ListEnvironmentsError {
399    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
400        match self {
401            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
402            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
403            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
404            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
405            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
406        }
407    }
408}
409impl ::std::fmt::Display for ListEnvironmentsError {
410    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
411        match self {
412            Self::AccessDeniedException(_inner) => _inner.fmt(f),
413            Self::InternalServerException(_inner) => _inner.fmt(f),
414            Self::ThrottlingException(_inner) => _inner.fmt(f),
415            Self::ValidationException(_inner) => _inner.fmt(f),
416            Self::Unhandled(_inner) => {
417                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
418                    write!(f, "unhandled error ({code})")
419                } else {
420                    f.write_str("unhandled error")
421                }
422            }
423        }
424    }
425}
426impl ::aws_smithy_types::retry::ProvideErrorKind for ListEnvironmentsError {
427    fn code(&self) -> ::std::option::Option<&str> {
428        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
429    }
430    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
431        match self {
432            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
433            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
434            _ => ::std::option::Option::None,
435        }
436    }
437}
438impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListEnvironmentsError {
439    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
440        match self {
441            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
442            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
443            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
444            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
445            Self::Unhandled(_inner) => &_inner.meta,
446        }
447    }
448}
449impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListEnvironmentsError {
450    fn create_unhandled_error(
451        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
452        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
453    ) -> Self {
454        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
455            source,
456            meta: meta.unwrap_or_default(),
457        })
458    }
459}
460impl ::aws_types::request_id::RequestId for crate::operation::list_environments::ListEnvironmentsError {
461    fn request_id(&self) -> Option<&str> {
462        self.meta().request_id()
463    }
464}
465
466pub use crate::operation::list_environments::_list_environments_input::ListEnvironmentsInput;
467
468pub use crate::operation::list_environments::_list_environments_output::ListEnvironmentsOutput;
469
470mod _list_environments_input;
471
472mod _list_environments_output;
473
474/// Builders
475pub mod builders;
476
477/// Paginator for this operation
478pub mod paginator;
aws_sdk_m2/operation/list_environments.rs

aws_sdk_m2/operation/
list_environments.rs
