aws_sdk_datazone/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        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("datazone", "ListEnvironments", input, runtime_plugins, stop_point).await
54    }
55
56    pub(crate) fn operation_runtime_plugins(
57        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
58        client_config: &crate::config::Config,
59        config_override: ::std::option::Option<crate::config::Builder>,
60    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
61        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
62        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
63            ::aws_runtime::auth::sigv4::SCHEME_ID,
64        ]));
65        if let ::std::option::Option::Some(config_override) = config_override {
66            for plugin in config_override.runtime_plugins.iter().cloned() {
67                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
68            }
69            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
70                config_override,
71                client_config.config.clone(),
72                &client_config.runtime_components,
73            ));
74        }
75        runtime_plugins
76    }
77}
78impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ListEnvironments {
79    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
80        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListEnvironments");
81
82        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
83            ListEnvironmentsRequestSerializer,
84        ));
85        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
86            ListEnvironmentsResponseDeserializer,
87        ));
88
89        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
90            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
91        ));
92
93        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
94        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
95            "ListEnvironments",
96            "datazone",
97        ));
98        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
99        signing_options.double_uri_encode = true;
100        signing_options.content_sha256_header = false;
101        signing_options.normalize_uri_path = true;
102        signing_options.payload_override = None;
103
104        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
105            signing_options,
106            ..::std::default::Default::default()
107        });
108
109        ::std::option::Option::Some(cfg.freeze())
110    }
111
112    fn runtime_components(
113        &self,
114        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
115    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
116        #[allow(unused_mut)]
117        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListEnvironments")
118            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
119            .with_interceptor(ListEnvironmentsEndpointParamsInterceptor)
120            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
121                crate::operation::list_environments::ListEnvironmentsError,
122            >::new())
123            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
124                crate::operation::list_environments::ListEnvironmentsError,
125            >::new())
126            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
127                crate::operation::list_environments::ListEnvironmentsError,
128            >::new());
129
130        ::std::borrow::Cow::Owned(rcb)
131    }
132}
133
134#[derive(Debug)]
135struct ListEnvironmentsResponseDeserializer;
136impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListEnvironmentsResponseDeserializer {
137    fn deserialize_nonstreaming(
138        &self,
139        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
140    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
141        let (success, status) = (response.status().is_success(), response.status().as_u16());
142        let headers = response.headers();
143        let body = response.body().bytes().expect("body loaded");
144        #[allow(unused_mut)]
145        let mut force_error = false;
146        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
147        let parse_result = if !success && status != 200 || force_error {
148            crate::protocol_serde::shape_list_environments::de_list_environments_http_error(status, headers, body)
149        } else {
150            crate::protocol_serde::shape_list_environments::de_list_environments_http_response(status, headers, body)
151        };
152        crate::protocol_serde::type_erase_result(parse_result)
153    }
154}
155#[derive(Debug)]
156struct ListEnvironmentsRequestSerializer;
157impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListEnvironmentsRequestSerializer {
158    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
159    fn serialize_input(
160        &self,
161        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
162        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
163    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
164        let input = input
165            .downcast::<crate::operation::list_environments::ListEnvironmentsInput>()
166            .expect("correct type");
167        let _header_serialization_settings = _cfg
168            .load::<crate::serialization_settings::HeaderSerializationSettings>()
169            .cloned()
170            .unwrap_or_default();
171        let mut request_builder = {
172            fn uri_base(
173                _input: &crate::operation::list_environments::ListEnvironmentsInput,
174                output: &mut ::std::string::String,
175            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
176                use ::std::fmt::Write as _;
177                let input_1 = &_input.domain_identifier;
178                let input_1 = input_1.as_ref().ok_or_else(|| {
179                    ::aws_smithy_types::error::operation::BuildError::missing_field("domain_identifier", "cannot be empty or unset")
180                })?;
181                let domain_identifier = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
182                if domain_identifier.is_empty() {
183                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
184                        "domain_identifier",
185                        "cannot be empty or unset",
186                    ));
187                }
188                ::std::write!(
189                    output,
190                    "/v2/domains/{domainIdentifier}/environments",
191                    domainIdentifier = domain_identifier
192                )
193                .expect("formatting should succeed");
194                ::std::result::Result::Ok(())
195            }
196            fn uri_query(
197                _input: &crate::operation::list_environments::ListEnvironmentsInput,
198                mut output: &mut ::std::string::String,
199            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
200                let mut query = ::aws_smithy_http::query::Writer::new(output);
201                if let ::std::option::Option::Some(inner_2) = &_input.aws_account_id {
202                    {
203                        query.push_kv("awsAccountId", &::aws_smithy_http::query::fmt_string(inner_2));
204                    }
205                }
206                if let ::std::option::Option::Some(inner_3) = &_input.status {
207                    {
208                        query.push_kv("status", &::aws_smithy_http::query::fmt_string(inner_3));
209                    }
210                }
211                if let ::std::option::Option::Some(inner_4) = &_input.aws_account_region {
212                    {
213                        query.push_kv("awsAccountRegion", &::aws_smithy_http::query::fmt_string(inner_4));
214                    }
215                }
216                let inner_5 = &_input.project_identifier;
217                let inner_5 = inner_5.as_ref().ok_or_else(|| {
218                    ::aws_smithy_types::error::operation::BuildError::missing_field("project_identifier", "cannot be empty or unset")
219                })?;
220                if inner_5.is_empty() {
221                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
222                        "project_identifier",
223                        "cannot be empty or unset",
224                    ));
225                }
226                query.push_kv("projectIdentifier", &::aws_smithy_http::query::fmt_string(inner_5));
227                if let ::std::option::Option::Some(inner_6) = &_input.environment_profile_identifier {
228                    {
229                        query.push_kv("environmentProfileIdentifier", &::aws_smithy_http::query::fmt_string(inner_6));
230                    }
231                }
232                if let ::std::option::Option::Some(inner_7) = &_input.environment_blueprint_identifier {
233                    {
234                        query.push_kv("environmentBlueprintIdentifier", &::aws_smithy_http::query::fmt_string(inner_7));
235                    }
236                }
237                if let ::std::option::Option::Some(inner_8) = &_input.provider {
238                    {
239                        query.push_kv("provider", &::aws_smithy_http::query::fmt_string(inner_8));
240                    }
241                }
242                if let ::std::option::Option::Some(inner_9) = &_input.name {
243                    {
244                        query.push_kv("name", &::aws_smithy_http::query::fmt_string(inner_9));
245                    }
246                }
247                if let ::std::option::Option::Some(inner_10) = &_input.max_results {
248                    {
249                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_10).encode());
250                    }
251                }
252                if let ::std::option::Option::Some(inner_11) = &_input.next_token {
253                    {
254                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_11));
255                    }
256                }
257                ::std::result::Result::Ok(())
258            }
259            #[allow(clippy::unnecessary_wraps)]
260            fn update_http_builder(
261                input: &crate::operation::list_environments::ListEnvironmentsInput,
262                builder: ::http::request::Builder,
263            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
264                let mut uri = ::std::string::String::new();
265                uri_base(input, &mut uri)?;
266                uri_query(input, &mut uri)?;
267                ::std::result::Result::Ok(builder.method("GET").uri(uri))
268            }
269            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
270            builder
271        };
272        let body = ::aws_smithy_types::body::SdkBody::from("");
273
274        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
275    }
276}
277#[derive(Debug)]
278struct ListEnvironmentsEndpointParamsInterceptor;
279
280impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListEnvironmentsEndpointParamsInterceptor {
281    fn name(&self) -> &'static str {
282        "ListEnvironmentsEndpointParamsInterceptor"
283    }
284
285    fn read_before_execution(
286        &self,
287        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
288            '_,
289            ::aws_smithy_runtime_api::client::interceptors::context::Input,
290            ::aws_smithy_runtime_api::client::interceptors::context::Output,
291            ::aws_smithy_runtime_api::client::interceptors::context::Error,
292        >,
293        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
294    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
295        let _input = context
296            .input()
297            .downcast_ref::<ListEnvironmentsInput>()
298            .ok_or("failed to downcast to ListEnvironmentsInput")?;
299
300        let params = crate::config::endpoint::Params::builder()
301            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
302            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
303            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
304            .build()
305            .map_err(|err| {
306                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
307            })?;
308        cfg.interceptor_state()
309            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
310        ::std::result::Result::Ok(())
311    }
312}
313
314// The get_* functions below are generated from JMESPath expressions in the
315// operationContextParams trait. They target the operation's input shape.
316
317/// Error type for the `ListEnvironmentsError` operation.
318#[non_exhaustive]
319#[derive(::std::fmt::Debug)]
320pub enum ListEnvironmentsError {
321    /// <p>You do not have sufficient access to perform this action.</p>
322    AccessDeniedException(crate::types::error::AccessDeniedException),
323    /// <p>The request has failed because of an unknown error, exception or failure.</p>
324    InternalServerException(crate::types::error::InternalServerException),
325    /// <p>The request was denied due to request throttling.</p>
326    ThrottlingException(crate::types::error::ThrottlingException),
327    /// <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
328    ValidationException(crate::types::error::ValidationException),
329    /// <p>You do not have permission to perform this action.</p>
330    UnauthorizedException(crate::types::error::UnauthorizedException),
331    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
332    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
333    variable wildcard pattern and check `.code()`:
334     \
335    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
336     \
337    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListEnvironmentsError) for what information is available for the error.")]
338    Unhandled(crate::error::sealed_unhandled::Unhandled),
339}
340impl ListEnvironmentsError {
341    /// Creates the `ListEnvironmentsError::Unhandled` variant from any error type.
342    pub fn unhandled(
343        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
344    ) -> Self {
345        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
346            source: err.into(),
347            meta: ::std::default::Default::default(),
348        })
349    }
350
351    /// Creates the `ListEnvironmentsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
352    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
353        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
354            source: err.clone().into(),
355            meta: err,
356        })
357    }
358    ///
359    /// Returns error metadata, which includes the error code, message,
360    /// request ID, and potentially additional information.
361    ///
362    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
363        match self {
364            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
365            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
366            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
367            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
368            Self::UnauthorizedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
369            Self::Unhandled(e) => &e.meta,
370        }
371    }
372    /// Returns `true` if the error kind is `ListEnvironmentsError::AccessDeniedException`.
373    pub fn is_access_denied_exception(&self) -> bool {
374        matches!(self, Self::AccessDeniedException(_))
375    }
376    /// Returns `true` if the error kind is `ListEnvironmentsError::InternalServerException`.
377    pub fn is_internal_server_exception(&self) -> bool {
378        matches!(self, Self::InternalServerException(_))
379    }
380    /// Returns `true` if the error kind is `ListEnvironmentsError::ThrottlingException`.
381    pub fn is_throttling_exception(&self) -> bool {
382        matches!(self, Self::ThrottlingException(_))
383    }
384    /// Returns `true` if the error kind is `ListEnvironmentsError::ValidationException`.
385    pub fn is_validation_exception(&self) -> bool {
386        matches!(self, Self::ValidationException(_))
387    }
388    /// Returns `true` if the error kind is `ListEnvironmentsError::UnauthorizedException`.
389    pub fn is_unauthorized_exception(&self) -> bool {
390        matches!(self, Self::UnauthorizedException(_))
391    }
392}
393impl ::std::error::Error for ListEnvironmentsError {
394    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
395        match self {
396            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
397            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
398            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
399            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
400            Self::UnauthorizedException(_inner) => ::std::option::Option::Some(_inner),
401            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
402        }
403    }
404}
405impl ::std::fmt::Display for ListEnvironmentsError {
406    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
407        match self {
408            Self::AccessDeniedException(_inner) => _inner.fmt(f),
409            Self::InternalServerException(_inner) => _inner.fmt(f),
410            Self::ThrottlingException(_inner) => _inner.fmt(f),
411            Self::ValidationException(_inner) => _inner.fmt(f),
412            Self::UnauthorizedException(_inner) => _inner.fmt(f),
413            Self::Unhandled(_inner) => {
414                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
415                    write!(f, "unhandled error ({code})")
416                } else {
417                    f.write_str("unhandled error")
418                }
419            }
420        }
421    }
422}
423impl ::aws_smithy_types::retry::ProvideErrorKind for ListEnvironmentsError {
424    fn code(&self) -> ::std::option::Option<&str> {
425        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
426    }
427    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
428        match self {
429            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
430            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
431            _ => ::std::option::Option::None,
432        }
433    }
434}
435impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListEnvironmentsError {
436    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
437        match self {
438            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
439            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
440            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
441            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
442            Self::UnauthorizedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
443            Self::Unhandled(_inner) => &_inner.meta,
444        }
445    }
446}
447impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListEnvironmentsError {
448    fn create_unhandled_error(
449        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
450        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
451    ) -> Self {
452        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
453            source,
454            meta: meta.unwrap_or_default(),
455        })
456    }
457}
458impl ::aws_types::request_id::RequestId for crate::operation::list_environments::ListEnvironmentsError {
459    fn request_id(&self) -> Option<&str> {
460        self.meta().request_id()
461    }
462}
463
464pub use crate::operation::list_environments::_list_environments_output::ListEnvironmentsOutput;
465
466pub use crate::operation::list_environments::_list_environments_input::ListEnvironmentsInput;
467
468mod _list_environments_input;
469
470mod _list_environments_output;
471
472/// Builders
473pub mod builders;
474
475/// Paginator for this operation
476pub mod paginator;