aws_sdk_cloud9/operation/
describe_environments.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeEnvironments`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeEnvironments;
6impl DescribeEnvironments {
7    /// Creates a new `DescribeEnvironments`
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::describe_environments::DescribeEnvironmentsInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_environments::DescribeEnvironmentsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_environments::DescribeEnvironmentsError,
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::describe_environments::DescribeEnvironmentsError>()
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::describe_environments::DescribeEnvironmentsOutput>()
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::describe_environments::DescribeEnvironmentsInput,
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("Cloud9", "DescribeEnvironments", 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                "Cloud9.DescribeEnvironments",
59                "rpc.service" = "Cloud9",
60                "rpc.method" = "DescribeEnvironments",
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        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
74            ::aws_runtime::auth::sigv4::SCHEME_ID,
75        ]));
76        if let ::std::option::Option::Some(config_override) = config_override {
77            for plugin in config_override.runtime_plugins.iter().cloned() {
78                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
79            }
80            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
81                config_override,
82                client_config.config.clone(),
83                &client_config.runtime_components,
84            ));
85        }
86        runtime_plugins
87    }
88}
89impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeEnvironments {
90    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
91        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeEnvironments");
92
93        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
94            DescribeEnvironmentsRequestSerializer,
95        ));
96        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
97            DescribeEnvironmentsResponseDeserializer,
98        ));
99
100        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
101            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
102        ));
103
104        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "DescribeEnvironments",
107            "Cloud9",
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("DescribeEnvironments")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(DescribeEnvironmentsEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::describe_environments::DescribeEnvironmentsError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::describe_environments::DescribeEnvironmentsError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::describe_environments::DescribeEnvironmentsError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct DescribeEnvironmentsResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeEnvironmentsResponseDeserializer {
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_describe_environments::de_describe_environments_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_describe_environments::de_describe_environments_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct DescribeEnvironmentsRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeEnvironmentsRequestSerializer {
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::describe_environments::DescribeEnvironmentsInput>()
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::describe_environments::DescribeEnvironmentsInput,
185                output: &mut ::std::string::String,
186            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
187                use ::std::fmt::Write as _;
188                ::std::write!(output, "/").expect("formatting should succeed");
189                ::std::result::Result::Ok(())
190            }
191            #[allow(clippy::unnecessary_wraps)]
192            fn update_http_builder(
193                input: &crate::operation::describe_environments::DescribeEnvironmentsInput,
194                builder: ::http::request::Builder,
195            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
196                let mut uri = ::std::string::String::new();
197                uri_base(input, &mut uri)?;
198                ::std::result::Result::Ok(builder.method("POST").uri(uri))
199            }
200            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
201            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
202            builder = _header_serialization_settings.set_default_header(
203                builder,
204                ::http::header::HeaderName::from_static("x-amz-target"),
205                "AWSCloud9WorkspaceManagementService.DescribeEnvironments",
206            );
207            builder
208        };
209        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_describe_environments::ser_describe_environments_input(
210            &input,
211        )?);
212        if let Some(content_length) = body.content_length() {
213            let content_length = content_length.to_string();
214            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
215        }
216        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
217    }
218}
219#[derive(Debug)]
220struct DescribeEnvironmentsEndpointParamsInterceptor;
221
222impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeEnvironmentsEndpointParamsInterceptor {
223    fn name(&self) -> &'static str {
224        "DescribeEnvironmentsEndpointParamsInterceptor"
225    }
226
227    fn read_before_execution(
228        &self,
229        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
230            '_,
231            ::aws_smithy_runtime_api::client::interceptors::context::Input,
232            ::aws_smithy_runtime_api::client::interceptors::context::Output,
233            ::aws_smithy_runtime_api::client::interceptors::context::Error,
234        >,
235        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
236    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
237        let _input = context
238            .input()
239            .downcast_ref::<DescribeEnvironmentsInput>()
240            .ok_or("failed to downcast to DescribeEnvironmentsInput")?;
241
242        let params = crate::config::endpoint::Params::builder()
243            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
244            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
245            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
246            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
247            .build()
248            .map_err(|err| {
249                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
250            })?;
251        cfg.interceptor_state()
252            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
253        ::std::result::Result::Ok(())
254    }
255}
256
257// The get_* functions below are generated from JMESPath expressions in the
258// operationContextParams trait. They target the operation's input shape.
259
260/// Error type for the `DescribeEnvironmentsError` operation.
261#[non_exhaustive]
262#[derive(::std::fmt::Debug)]
263pub enum DescribeEnvironmentsError {
264    /// <p>The target request is invalid.</p>
265    BadRequestException(crate::types::error::BadRequestException),
266    /// <p>A conflict occurred.</p>
267    ConflictException(crate::types::error::ConflictException),
268    /// <p>An access permissions issue occurred.</p>
269    ForbiddenException(crate::types::error::ForbiddenException),
270    /// <p>An internal server error occurred.</p>
271    InternalServerErrorException(crate::types::error::InternalServerErrorException),
272    /// <p>A service limit was exceeded.</p>
273    LimitExceededException(crate::types::error::LimitExceededException),
274    /// <p>The target resource cannot be found.</p>
275    NotFoundException(crate::types::error::NotFoundException),
276    /// <p>Too many service requests were made over the given time period.</p>
277    TooManyRequestsException(crate::types::error::TooManyRequestsException),
278    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
279    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
280    variable wildcard pattern and check `.code()`:
281     \
282    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
283     \
284    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeEnvironmentsError) for what information is available for the error.")]
285    Unhandled(crate::error::sealed_unhandled::Unhandled),
286}
287impl DescribeEnvironmentsError {
288    /// Creates the `DescribeEnvironmentsError::Unhandled` variant from any error type.
289    pub fn unhandled(
290        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
291    ) -> Self {
292        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
293            source: err.into(),
294            meta: ::std::default::Default::default(),
295        })
296    }
297
298    /// Creates the `DescribeEnvironmentsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
299    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
300        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
301            source: err.clone().into(),
302            meta: err,
303        })
304    }
305    ///
306    /// Returns error metadata, which includes the error code, message,
307    /// request ID, and potentially additional information.
308    ///
309    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
310        match self {
311            Self::BadRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
312            Self::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::ForbiddenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::InternalServerErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
315            Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
317            Self::TooManyRequestsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
318            Self::Unhandled(e) => &e.meta,
319        }
320    }
321    /// Returns `true` if the error kind is `DescribeEnvironmentsError::BadRequestException`.
322    pub fn is_bad_request_exception(&self) -> bool {
323        matches!(self, Self::BadRequestException(_))
324    }
325    /// Returns `true` if the error kind is `DescribeEnvironmentsError::ConflictException`.
326    pub fn is_conflict_exception(&self) -> bool {
327        matches!(self, Self::ConflictException(_))
328    }
329    /// Returns `true` if the error kind is `DescribeEnvironmentsError::ForbiddenException`.
330    pub fn is_forbidden_exception(&self) -> bool {
331        matches!(self, Self::ForbiddenException(_))
332    }
333    /// Returns `true` if the error kind is `DescribeEnvironmentsError::InternalServerErrorException`.
334    pub fn is_internal_server_error_exception(&self) -> bool {
335        matches!(self, Self::InternalServerErrorException(_))
336    }
337    /// Returns `true` if the error kind is `DescribeEnvironmentsError::LimitExceededException`.
338    pub fn is_limit_exceeded_exception(&self) -> bool {
339        matches!(self, Self::LimitExceededException(_))
340    }
341    /// Returns `true` if the error kind is `DescribeEnvironmentsError::NotFoundException`.
342    pub fn is_not_found_exception(&self) -> bool {
343        matches!(self, Self::NotFoundException(_))
344    }
345    /// Returns `true` if the error kind is `DescribeEnvironmentsError::TooManyRequestsException`.
346    pub fn is_too_many_requests_exception(&self) -> bool {
347        matches!(self, Self::TooManyRequestsException(_))
348    }
349}
350impl ::std::error::Error for DescribeEnvironmentsError {
351    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
352        match self {
353            Self::BadRequestException(_inner) => ::std::option::Option::Some(_inner),
354            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
355            Self::ForbiddenException(_inner) => ::std::option::Option::Some(_inner),
356            Self::InternalServerErrorException(_inner) => ::std::option::Option::Some(_inner),
357            Self::LimitExceededException(_inner) => ::std::option::Option::Some(_inner),
358            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
359            Self::TooManyRequestsException(_inner) => ::std::option::Option::Some(_inner),
360            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
361        }
362    }
363}
364impl ::std::fmt::Display for DescribeEnvironmentsError {
365    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
366        match self {
367            Self::BadRequestException(_inner) => _inner.fmt(f),
368            Self::ConflictException(_inner) => _inner.fmt(f),
369            Self::ForbiddenException(_inner) => _inner.fmt(f),
370            Self::InternalServerErrorException(_inner) => _inner.fmt(f),
371            Self::LimitExceededException(_inner) => _inner.fmt(f),
372            Self::NotFoundException(_inner) => _inner.fmt(f),
373            Self::TooManyRequestsException(_inner) => _inner.fmt(f),
374            Self::Unhandled(_inner) => {
375                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
376                    write!(f, "unhandled error ({code})")
377                } else {
378                    f.write_str("unhandled error")
379                }
380            }
381        }
382    }
383}
384impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeEnvironmentsError {
385    fn code(&self) -> ::std::option::Option<&str> {
386        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
387    }
388    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
389        ::std::option::Option::None
390    }
391}
392impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeEnvironmentsError {
393    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
394        match self {
395            Self::BadRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
396            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
397            Self::ForbiddenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
398            Self::InternalServerErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
399            Self::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
400            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
401            Self::TooManyRequestsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::Unhandled(_inner) => &_inner.meta,
403        }
404    }
405}
406impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeEnvironmentsError {
407    fn create_unhandled_error(
408        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
409        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
410    ) -> Self {
411        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
412            source,
413            meta: meta.unwrap_or_default(),
414        })
415    }
416}
417impl ::aws_types::request_id::RequestId for crate::operation::describe_environments::DescribeEnvironmentsError {
418    fn request_id(&self) -> Option<&str> {
419        self.meta().request_id()
420    }
421}
422
423pub use crate::operation::describe_environments::_describe_environments_output::DescribeEnvironmentsOutput;
424
425pub use crate::operation::describe_environments::_describe_environments_input::DescribeEnvironmentsInput;
426
427mod _describe_environments_input;
428
429mod _describe_environments_output;
430
431/// Builders
432pub mod builders;
aws_sdk_cloud9/operation/describe_environments.rs

aws_sdk_cloud9/operation/
describe_environments.rs
