aws_sdk_workspacesweb/operation/
list_sessions.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListSessions`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListSessions;
6impl ListSessions {
7    /// Creates a new `ListSessions`
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_sessions::ListSessionsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_sessions::ListSessionsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_sessions::ListSessionsError,
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_sessions::ListSessionsError>()
27                    .expect("correct error type")
28            })
29        };
30        use ::tracing::Instrument;
31        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
32            // Create a parent span for the entire operation. Includes a random, internal-only,
33            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
34            .instrument(::tracing::debug_span!(
35                "workspacesweb.ListSessions",
36                "rpc.service" = "workspacesweb",
37                "rpc.method" = "ListSessions",
38                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
39                "rpc.system" = "aws-api",
40            ))
41            .await
42            .map_err(map_err)?;
43        let output = context.finalize().map_err(map_err)?;
44        ::std::result::Result::Ok(
45            output
46                .downcast::<crate::operation::list_sessions::ListSessionsOutput>()
47                .expect("correct output type"),
48        )
49    }
50
51    pub(crate) async fn orchestrate_with_stop_point(
52        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
53        input: crate::operation::list_sessions::ListSessionsInput,
54        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
55    ) -> ::std::result::Result<
56        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
57        ::aws_smithy_runtime_api::client::result::SdkError<
58            ::aws_smithy_runtime_api::client::interceptors::context::Error,
59            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
60        >,
61    > {
62        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
63        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("workspacesweb", "ListSessions", input, runtime_plugins, stop_point).await
64    }
65
66    pub(crate) fn operation_runtime_plugins(
67        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
68        client_config: &crate::config::Config,
69        config_override: ::std::option::Option<crate::config::Builder>,
70    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
71        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
72        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
73            ::aws_runtime::auth::sigv4::SCHEME_ID,
74        ]));
75        if let ::std::option::Option::Some(config_override) = config_override {
76            for plugin in config_override.runtime_plugins.iter().cloned() {
77                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
78            }
79            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
80                config_override,
81                client_config.config.clone(),
82                &client_config.runtime_components,
83            ));
84        }
85        runtime_plugins
86    }
87}
88impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ListSessions {
89    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
90        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListSessions");
91
92        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
93            ListSessionsRequestSerializer,
94        ));
95        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
96            ListSessionsResponseDeserializer,
97        ));
98
99        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
100            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
101        ));
102
103        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
104        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
105            "ListSessions",
106            "workspacesweb",
107        ));
108        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
109        signing_options.double_uri_encode = true;
110        signing_options.content_sha256_header = false;
111        signing_options.normalize_uri_path = true;
112        signing_options.payload_override = None;
113
114        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
115            signing_options,
116            ..::std::default::Default::default()
117        });
118
119        ::std::option::Option::Some(cfg.freeze())
120    }
121
122    fn runtime_components(
123        &self,
124        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
125    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
126        #[allow(unused_mut)]
127        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListSessions")
128            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
129            .with_interceptor(ListSessionsEndpointParamsInterceptor)
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
131                crate::operation::list_sessions::ListSessionsError,
132            >::new())
133            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
134                crate::operation::list_sessions::ListSessionsError,
135            >::new())
136            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
137                crate::operation::list_sessions::ListSessionsError,
138            >::new());
139
140        ::std::borrow::Cow::Owned(rcb)
141    }
142}
143
144#[derive(Debug)]
145struct ListSessionsResponseDeserializer;
146impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListSessionsResponseDeserializer {
147    fn deserialize_nonstreaming(
148        &self,
149        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
150    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
151        let (success, status) = (response.status().is_success(), response.status().as_u16());
152        let headers = response.headers();
153        let body = response.body().bytes().expect("body loaded");
154        #[allow(unused_mut)]
155        let mut force_error = false;
156        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
157        let parse_result = if !success && status != 200 || force_error {
158            crate::protocol_serde::shape_list_sessions::de_list_sessions_http_error(status, headers, body)
159        } else {
160            crate::protocol_serde::shape_list_sessions::de_list_sessions_http_response(status, headers, body)
161        };
162        crate::protocol_serde::type_erase_result(parse_result)
163    }
164}
165#[derive(Debug)]
166struct ListSessionsRequestSerializer;
167impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListSessionsRequestSerializer {
168    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
169    fn serialize_input(
170        &self,
171        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
172        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
173    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
174        let input = input
175            .downcast::<crate::operation::list_sessions::ListSessionsInput>()
176            .expect("correct type");
177        let _header_serialization_settings = _cfg
178            .load::<crate::serialization_settings::HeaderSerializationSettings>()
179            .cloned()
180            .unwrap_or_default();
181        let mut request_builder = {
182            fn uri_base(
183                _input: &crate::operation::list_sessions::ListSessionsInput,
184                output: &mut ::std::string::String,
185            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
186                use ::std::fmt::Write as _;
187                let input_1 = &_input.portal_id;
188                let input_1 = input_1
189                    .as_ref()
190                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("portal_id", "cannot be empty or unset"))?;
191                let portal_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
192                if portal_id.is_empty() {
193                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
194                        "portal_id",
195                        "cannot be empty or unset",
196                    ));
197                }
198                ::std::write!(output, "/portals/{portalId}/sessions", portalId = portal_id).expect("formatting should succeed");
199                ::std::result::Result::Ok(())
200            }
201            fn uri_query(
202                _input: &crate::operation::list_sessions::ListSessionsInput,
203                mut output: &mut ::std::string::String,
204            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
205                let mut query = ::aws_smithy_http::query::Writer::new(output);
206                if let ::std::option::Option::Some(inner_2) = &_input.username {
207                    {
208                        query.push_kv("username", &::aws_smithy_http::query::fmt_string(inner_2));
209                    }
210                }
211                if let ::std::option::Option::Some(inner_3) = &_input.session_id {
212                    {
213                        query.push_kv("sessionId", &::aws_smithy_http::query::fmt_string(inner_3));
214                    }
215                }
216                if let ::std::option::Option::Some(inner_4) = &_input.sort_by {
217                    {
218                        query.push_kv("sortBy", &::aws_smithy_http::query::fmt_string(inner_4));
219                    }
220                }
221                if let ::std::option::Option::Some(inner_5) = &_input.status {
222                    {
223                        query.push_kv("status", &::aws_smithy_http::query::fmt_string(inner_5));
224                    }
225                }
226                if let ::std::option::Option::Some(inner_6) = &_input.max_results {
227                    {
228                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_6).encode());
229                    }
230                }
231                if let ::std::option::Option::Some(inner_7) = &_input.next_token {
232                    {
233                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_7));
234                    }
235                }
236                ::std::result::Result::Ok(())
237            }
238            #[allow(clippy::unnecessary_wraps)]
239            fn update_http_builder(
240                input: &crate::operation::list_sessions::ListSessionsInput,
241                builder: ::http::request::Builder,
242            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
243                let mut uri = ::std::string::String::new();
244                uri_base(input, &mut uri)?;
245                uri_query(input, &mut uri)?;
246                ::std::result::Result::Ok(builder.method("GET").uri(uri))
247            }
248            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
249            builder
250        };
251        let body = ::aws_smithy_types::body::SdkBody::from("");
252
253        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
254    }
255}
256#[derive(Debug)]
257struct ListSessionsEndpointParamsInterceptor;
258
259impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListSessionsEndpointParamsInterceptor {
260    fn name(&self) -> &'static str {
261        "ListSessionsEndpointParamsInterceptor"
262    }
263
264    fn read_before_execution(
265        &self,
266        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
267            '_,
268            ::aws_smithy_runtime_api::client::interceptors::context::Input,
269            ::aws_smithy_runtime_api::client::interceptors::context::Output,
270            ::aws_smithy_runtime_api::client::interceptors::context::Error,
271        >,
272        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
273    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
274        let _input = context
275            .input()
276            .downcast_ref::<ListSessionsInput>()
277            .ok_or("failed to downcast to ListSessionsInput")?;
278
279        let params = crate::config::endpoint::Params::builder()
280            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
281            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
282            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
283            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
284            .build()
285            .map_err(|err| {
286                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
287            })?;
288        cfg.interceptor_state()
289            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
290        ::std::result::Result::Ok(())
291    }
292}
293
294// The get_* functions below are generated from JMESPath expressions in the
295// operationContextParams trait. They target the operation's input shape.
296
297/// Error type for the `ListSessionsError` operation.
298#[non_exhaustive]
299#[derive(::std::fmt::Debug)]
300pub enum ListSessionsError {
301    /// <p>Access is denied.</p>
302    AccessDeniedException(crate::types::error::AccessDeniedException),
303    /// <p>There is an internal server error.</p>
304    InternalServerException(crate::types::error::InternalServerException),
305    /// <p>The resource cannot be found.</p>
306    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
307    /// <p>There is a throttling error.</p>
308    ThrottlingException(crate::types::error::ThrottlingException),
309    /// <p>There is a validation error.</p>
310    ValidationException(crate::types::error::ValidationException),
311    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
312    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
313    variable wildcard pattern and check `.code()`:
314     \
315    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
316     \
317    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListSessionsError) for what information is available for the error.")]
318    Unhandled(crate::error::sealed_unhandled::Unhandled),
319}
320impl ListSessionsError {
321    /// Creates the `ListSessionsError::Unhandled` variant from any error type.
322    pub fn unhandled(
323        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
324    ) -> Self {
325        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
326            source: err.into(),
327            meta: ::std::default::Default::default(),
328        })
329    }
330
331    /// Creates the `ListSessionsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
332    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
333        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
334            source: err.clone().into(),
335            meta: err,
336        })
337    }
338    ///
339    /// Returns error metadata, which includes the error code, message,
340    /// request ID, and potentially additional information.
341    ///
342    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
343        match self {
344            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
345            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
346            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
347            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
348            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
349            Self::Unhandled(e) => &e.meta,
350        }
351    }
352    /// Returns `true` if the error kind is `ListSessionsError::AccessDeniedException`.
353    pub fn is_access_denied_exception(&self) -> bool {
354        matches!(self, Self::AccessDeniedException(_))
355    }
356    /// Returns `true` if the error kind is `ListSessionsError::InternalServerException`.
357    pub fn is_internal_server_exception(&self) -> bool {
358        matches!(self, Self::InternalServerException(_))
359    }
360    /// Returns `true` if the error kind is `ListSessionsError::ResourceNotFoundException`.
361    pub fn is_resource_not_found_exception(&self) -> bool {
362        matches!(self, Self::ResourceNotFoundException(_))
363    }
364    /// Returns `true` if the error kind is `ListSessionsError::ThrottlingException`.
365    pub fn is_throttling_exception(&self) -> bool {
366        matches!(self, Self::ThrottlingException(_))
367    }
368    /// Returns `true` if the error kind is `ListSessionsError::ValidationException`.
369    pub fn is_validation_exception(&self) -> bool {
370        matches!(self, Self::ValidationException(_))
371    }
372}
373impl ::std::error::Error for ListSessionsError {
374    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
375        match self {
376            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
377            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
378            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
379            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
380            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
381            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
382        }
383    }
384}
385impl ::std::fmt::Display for ListSessionsError {
386    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
387        match self {
388            Self::AccessDeniedException(_inner) => _inner.fmt(f),
389            Self::InternalServerException(_inner) => _inner.fmt(f),
390            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
391            Self::ThrottlingException(_inner) => _inner.fmt(f),
392            Self::ValidationException(_inner) => _inner.fmt(f),
393            Self::Unhandled(_inner) => {
394                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
395                    write!(f, "unhandled error ({code})")
396                } else {
397                    f.write_str("unhandled error")
398                }
399            }
400        }
401    }
402}
403impl ::aws_smithy_types::retry::ProvideErrorKind for ListSessionsError {
404    fn code(&self) -> ::std::option::Option<&str> {
405        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
406    }
407    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
408        ::std::option::Option::None
409    }
410}
411impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListSessionsError {
412    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
413        match self {
414            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
415            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
416            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
417            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
418            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
419            Self::Unhandled(_inner) => &_inner.meta,
420        }
421    }
422}
423impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListSessionsError {
424    fn create_unhandled_error(
425        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
426        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
427    ) -> Self {
428        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
429            source,
430            meta: meta.unwrap_or_default(),
431        })
432    }
433}
434impl ::aws_types::request_id::RequestId for crate::operation::list_sessions::ListSessionsError {
435    fn request_id(&self) -> Option<&str> {
436        self.meta().request_id()
437    }
438}
439
440pub use crate::operation::list_sessions::_list_sessions_output::ListSessionsOutput;
441
442pub use crate::operation::list_sessions::_list_sessions_input::ListSessionsInput;
443
444mod _list_sessions_input;
445
446mod _list_sessions_output;
447
448/// Builders
449pub mod builders;
450
451/// Paginator for this operation
452pub mod paginator;