aws_sdk_workspacesweb/operation/
list_portals.rs

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

aws_sdk_workspacesweb/operation/
list_portals.rs
