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        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_sessions::ListSessionsOutput>()
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_sessions::ListSessionsInput,
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", "ListSessions", 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.ListSessions",
59                "rpc.service" = "WorkSpaces Web",
60                "rpc.method" = "ListSessions",
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 ListSessions {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListSessions");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListSessionsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListSessionsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListSessions")
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            "ListSessions",
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("ListSessions")
130            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
131            .with_interceptor(ListSessionsEndpointParamsInterceptor)
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::list_sessions::ListSessionsError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::list_sessions::ListSessionsError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::list_sessions::ListSessionsError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct ListSessionsResponseDeserializer;
148impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListSessionsResponseDeserializer {
149    fn deserialize_nonstreaming(
150        &self,
151        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
152    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
153        let (success, status) = (response.status().is_success(), response.status().as_u16());
154        let headers = response.headers();
155        let body = response.body().bytes().expect("body loaded");
156        #[allow(unused_mut)]
157        let mut force_error = false;
158        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
159        let parse_result = if !success && status != 200 || force_error {
160            crate::protocol_serde::shape_list_sessions::de_list_sessions_http_error(status, headers, body)
161        } else {
162            crate::protocol_serde::shape_list_sessions::de_list_sessions_http_response(status, headers, body)
163        };
164        crate::protocol_serde::type_erase_result(parse_result)
165    }
166}
167#[derive(Debug)]
168struct ListSessionsRequestSerializer;
169impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListSessionsRequestSerializer {
170    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
171    fn serialize_input(
172        &self,
173        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
174        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
175    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
176        let input = input
177            .downcast::<crate::operation::list_sessions::ListSessionsInput>()
178            .expect("correct type");
179        let _header_serialization_settings = _cfg
180            .load::<crate::serialization_settings::HeaderSerializationSettings>()
181            .cloned()
182            .unwrap_or_default();
183        let mut request_builder = {
184            fn uri_base(
185                _input: &crate::operation::list_sessions::ListSessionsInput,
186                output: &mut ::std::string::String,
187            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
188                use ::std::fmt::Write as _;
189                let input_1 = &_input.portal_id;
190                let input_1 = input_1
191                    .as_ref()
192                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("portal_id", "cannot be empty or unset"))?;
193                let portal_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
194                if portal_id.is_empty() {
195                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
196                        "portal_id",
197                        "cannot be empty or unset",
198                    ));
199                }
200                ::std::write!(output, "/portals/{portalId}/sessions", portalId = portal_id).expect("formatting should succeed");
201                ::std::result::Result::Ok(())
202            }
203            fn uri_query(
204                _input: &crate::operation::list_sessions::ListSessionsInput,
205                mut output: &mut ::std::string::String,
206            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
207                let mut query = ::aws_smithy_http::query::Writer::new(output);
208                if let ::std::option::Option::Some(inner_2) = &_input.username {
209                    {
210                        query.push_kv("username", &::aws_smithy_http::query::fmt_string(inner_2));
211                    }
212                }
213                if let ::std::option::Option::Some(inner_3) = &_input.session_id {
214                    {
215                        query.push_kv("sessionId", &::aws_smithy_http::query::fmt_string(inner_3));
216                    }
217                }
218                if let ::std::option::Option::Some(inner_4) = &_input.sort_by {
219                    {
220                        query.push_kv("sortBy", &::aws_smithy_http::query::fmt_string(inner_4));
221                    }
222                }
223                if let ::std::option::Option::Some(inner_5) = &_input.status {
224                    {
225                        query.push_kv("status", &::aws_smithy_http::query::fmt_string(inner_5));
226                    }
227                }
228                if let ::std::option::Option::Some(inner_6) = &_input.max_results {
229                    {
230                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_6).encode());
231                    }
232                }
233                if let ::std::option::Option::Some(inner_7) = &_input.next_token {
234                    {
235                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_7));
236                    }
237                }
238                ::std::result::Result::Ok(())
239            }
240            #[allow(clippy::unnecessary_wraps)]
241            fn update_http_builder(
242                input: &crate::operation::list_sessions::ListSessionsInput,
243                builder: ::http::request::Builder,
244            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
245                let mut uri = ::std::string::String::new();
246                uri_base(input, &mut uri)?;
247                uri_query(input, &mut uri)?;
248                ::std::result::Result::Ok(builder.method("GET").uri(uri))
249            }
250            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
251            builder
252        };
253        let body = ::aws_smithy_types::body::SdkBody::from("");
254
255        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
256    }
257}
258#[derive(Debug)]
259struct ListSessionsEndpointParamsInterceptor;
260
261impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListSessionsEndpointParamsInterceptor {
262    fn name(&self) -> &'static str {
263        "ListSessionsEndpointParamsInterceptor"
264    }
265
266    fn read_before_execution(
267        &self,
268        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
269            '_,
270            ::aws_smithy_runtime_api::client::interceptors::context::Input,
271            ::aws_smithy_runtime_api::client::interceptors::context::Output,
272            ::aws_smithy_runtime_api::client::interceptors::context::Error,
273        >,
274        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
275    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
276        let _input = context
277            .input()
278            .downcast_ref::<ListSessionsInput>()
279            .ok_or("failed to downcast to ListSessionsInput")?;
280
281        let params = crate::config::endpoint::Params::builder()
282            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
283            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
284            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
285            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
286            .build()
287            .map_err(|err| {
288                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
289            })?;
290        cfg.interceptor_state()
291            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
292        ::std::result::Result::Ok(())
293    }
294}
295
296// The get_* functions below are generated from JMESPath expressions in the
297// operationContextParams trait. They target the operation's input shape.
298
299/// Error type for the `ListSessionsError` operation.
300#[non_exhaustive]
301#[derive(::std::fmt::Debug)]
302pub enum ListSessionsError {
303    /// <p>Access is denied.</p>
304    AccessDeniedException(crate::types::error::AccessDeniedException),
305    /// <p>There is an internal server error.</p>
306    InternalServerException(crate::types::error::InternalServerException),
307    /// <p>The resource cannot be found.</p>
308    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
309    /// <p>There is a throttling error.</p>
310    ThrottlingException(crate::types::error::ThrottlingException),
311    /// <p>There is a validation error.</p>
312    ValidationException(crate::types::error::ValidationException),
313    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
314    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
315    variable wildcard pattern and check `.code()`:
316     \
317    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
318     \
319    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListSessionsError) for what information is available for the error.")]
320    Unhandled(crate::error::sealed_unhandled::Unhandled),
321}
322impl ListSessionsError {
323    /// Creates the `ListSessionsError::Unhandled` variant from any error type.
324    pub fn unhandled(
325        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
326    ) -> Self {
327        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
328            source: err.into(),
329            meta: ::std::default::Default::default(),
330        })
331    }
332
333    /// Creates the `ListSessionsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
334    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
335        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
336            source: err.clone().into(),
337            meta: err,
338        })
339    }
340    ///
341    /// Returns error metadata, which includes the error code, message,
342    /// request ID, and potentially additional information.
343    ///
344    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
345        match self {
346            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
347            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
348            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
349            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
350            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
351            Self::Unhandled(e) => &e.meta,
352        }
353    }
354    /// Returns `true` if the error kind is `ListSessionsError::AccessDeniedException`.
355    pub fn is_access_denied_exception(&self) -> bool {
356        matches!(self, Self::AccessDeniedException(_))
357    }
358    /// Returns `true` if the error kind is `ListSessionsError::InternalServerException`.
359    pub fn is_internal_server_exception(&self) -> bool {
360        matches!(self, Self::InternalServerException(_))
361    }
362    /// Returns `true` if the error kind is `ListSessionsError::ResourceNotFoundException`.
363    pub fn is_resource_not_found_exception(&self) -> bool {
364        matches!(self, Self::ResourceNotFoundException(_))
365    }
366    /// Returns `true` if the error kind is `ListSessionsError::ThrottlingException`.
367    pub fn is_throttling_exception(&self) -> bool {
368        matches!(self, Self::ThrottlingException(_))
369    }
370    /// Returns `true` if the error kind is `ListSessionsError::ValidationException`.
371    pub fn is_validation_exception(&self) -> bool {
372        matches!(self, Self::ValidationException(_))
373    }
374}
375impl ::std::error::Error for ListSessionsError {
376    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
377        match self {
378            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
379            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
380            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
381            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
382            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
383            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
384        }
385    }
386}
387impl ::std::fmt::Display for ListSessionsError {
388    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
389        match self {
390            Self::AccessDeniedException(_inner) => _inner.fmt(f),
391            Self::InternalServerException(_inner) => _inner.fmt(f),
392            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
393            Self::ThrottlingException(_inner) => _inner.fmt(f),
394            Self::ValidationException(_inner) => _inner.fmt(f),
395            Self::Unhandled(_inner) => {
396                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
397                    write!(f, "unhandled error ({code})")
398                } else {
399                    f.write_str("unhandled error")
400                }
401            }
402        }
403    }
404}
405impl ::aws_smithy_types::retry::ProvideErrorKind for ListSessionsError {
406    fn code(&self) -> ::std::option::Option<&str> {
407        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
408    }
409    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
410        ::std::option::Option::None
411    }
412}
413impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListSessionsError {
414    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
415        match self {
416            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
417            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
418            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
419            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
420            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
421            Self::Unhandled(_inner) => &_inner.meta,
422        }
423    }
424}
425impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListSessionsError {
426    fn create_unhandled_error(
427        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
428        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
429    ) -> Self {
430        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
431            source,
432            meta: meta.unwrap_or_default(),
433        })
434    }
435}
436impl ::aws_types::request_id::RequestId for crate::operation::list_sessions::ListSessionsError {
437    fn request_id(&self) -> Option<&str> {
438        self.meta().request_id()
439    }
440}
441
442pub use crate::operation::list_sessions::_list_sessions_output::ListSessionsOutput;
443
444pub use crate::operation::list_sessions::_list_sessions_input::ListSessionsInput;
445
446mod _list_sessions_input;
447
448mod _list_sessions_output;
449
450/// Builders
451pub mod builders;
452
453/// Paginator for this operation
454pub mod paginator;