aws_sdk_chime/operation/
logout_user.rs

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