aws_sdk_sso/operation/
logout.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `Logout`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct Logout;
6impl Logout {
7    /// Creates a new `Logout`
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::LogoutInput,
14    ) -> ::std::result::Result<
15        crate::operation::logout::LogoutOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::logout::LogoutError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::logout::LogoutError>().expect("correct error type")) };
26        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
27            .await
28            .map_err(map_err)?;
29        let output = context.finalize().map_err(map_err)?;
30        ::std::result::Result::Ok(output.downcast::<crate::operation::logout::LogoutOutput>().expect("correct output type"))
31    }
32
33    pub(crate) async fn orchestrate_with_stop_point(
34        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
35        input: crate::operation::logout::LogoutInput,
36        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
37    ) -> ::std::result::Result<
38        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
39        ::aws_smithy_runtime_api::client::result::SdkError<
40            ::aws_smithy_runtime_api::client::interceptors::context::Error,
41            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
42        >,
43    > {
44        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
45        use ::tracing::Instrument;
46        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("SSO", "Logout", input, runtime_plugins, stop_point)
47            // Create a parent span for the entire operation. Includes a random, internal-only,
48            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
49            .instrument(::tracing::debug_span!(
50                "SSO.Logout",
51                "rpc.service" = "SSO",
52                "rpc.method" = "Logout",
53                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
54                "rpc.system" = "aws-api",
55            ))
56            .await
57    }
58
59    pub(crate) fn operation_runtime_plugins(
60        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
61        client_config: &crate::config::Config,
62        config_override: ::std::option::Option<crate::config::Builder>,
63    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
64        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
65
66        if let ::std::option::Option::Some(config_override) = config_override {
67            for plugin in config_override.runtime_plugins.iter().cloned() {
68                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
69            }
70            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
71                config_override,
72                client_config.config.clone(),
73                &client_config.runtime_components,
74            ));
75        }
76        runtime_plugins
77    }
78}
79impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for Logout {
80    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
81        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("Logout");
82
83        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
84            LogoutRequestSerializer,
85        ));
86        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
87            LogoutResponseDeserializer,
88        ));
89
90        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
91            crate::config::auth::Params::builder()
92                .operation_name("Logout")
93                .build()
94                .expect("required fields set"),
95        ));
96
97        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("Logout", "SSO"));
98
99        ::std::option::Option::Some(cfg.freeze())
100    }
101
102    fn runtime_components(
103        &self,
104        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
105    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
106        #[allow(unused_mut)]
107        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("Logout")
108            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
109            .with_interceptor(LogoutEndpointParamsInterceptor)
110            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
111                crate::operation::logout::LogoutError,
112            >::new())
113            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
114                crate::operation::logout::LogoutError,
115            >::new())
116            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
117                crate::operation::logout::LogoutError,
118            >::new());
119
120        ::std::borrow::Cow::Owned(rcb)
121    }
122}
123
124#[derive(Debug)]
125struct LogoutResponseDeserializer;
126impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for LogoutResponseDeserializer {
127    fn deserialize_nonstreaming(
128        &self,
129        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
130    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
131        let (success, status) = (response.status().is_success(), response.status().as_u16());
132        let headers = response.headers();
133        let body = response.body().bytes().expect("body loaded");
134        #[allow(unused_mut)]
135        let mut force_error = false;
136        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
137        let parse_result = if !success && status != 200 || force_error {
138            crate::protocol_serde::shape_logout::de_logout_http_error(status, headers, body)
139        } else {
140            crate::protocol_serde::shape_logout::de_logout_http_response(status, headers, body)
141        };
142        crate::protocol_serde::type_erase_result(parse_result)
143    }
144}
145#[derive(Debug)]
146struct LogoutRequestSerializer;
147impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for LogoutRequestSerializer {
148    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
149    fn serialize_input(
150        &self,
151        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
152        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
153    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
154        let input = input.downcast::<crate::operation::logout::LogoutInput>().expect("correct type");
155        let _header_serialization_settings = _cfg
156            .load::<crate::serialization_settings::HeaderSerializationSettings>()
157            .cloned()
158            .unwrap_or_default();
159        let mut request_builder = {
160            #[allow(clippy::uninlined_format_args)]
161            fn uri_base(
162                _input: &crate::operation::logout::LogoutInput,
163                output: &mut ::std::string::String,
164            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
165                use ::std::fmt::Write as _;
166                ::std::write!(output, "/logout").expect("formatting should succeed");
167                ::std::result::Result::Ok(())
168            }
169            #[allow(clippy::unnecessary_wraps)]
170            fn update_http_builder(
171                input: &crate::operation::logout::LogoutInput,
172                builder: ::http::request::Builder,
173            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
174                let mut uri = ::std::string::String::new();
175                uri_base(input, &mut uri)?;
176                let builder = crate::protocol_serde::shape_logout::ser_logout_headers(input, builder)?;
177                ::std::result::Result::Ok(builder.method("POST").uri(uri))
178            }
179            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
180            builder
181        };
182        let body = ::aws_smithy_types::body::SdkBody::from("");
183
184        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
185    }
186}
187#[derive(Debug)]
188struct LogoutEndpointParamsInterceptor;
189
190impl ::aws_smithy_runtime_api::client::interceptors::Intercept for LogoutEndpointParamsInterceptor {
191    fn name(&self) -> &'static str {
192        "LogoutEndpointParamsInterceptor"
193    }
194
195    fn read_before_execution(
196        &self,
197        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
198            '_,
199            ::aws_smithy_runtime_api::client::interceptors::context::Input,
200            ::aws_smithy_runtime_api::client::interceptors::context::Output,
201            ::aws_smithy_runtime_api::client::interceptors::context::Error,
202        >,
203        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
204    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
205        let _input = context.input().downcast_ref::<LogoutInput>().ok_or("failed to downcast to LogoutInput")?;
206
207        let params = crate::config::endpoint::Params::builder()
208            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
209            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
210            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
211            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
212            .build()
213            .map_err(|err| {
214                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
215            })?;
216        cfg.interceptor_state()
217            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
218        ::std::result::Result::Ok(())
219    }
220}
221
222// The get_* functions below are generated from JMESPath expressions in the
223// operationContextParams trait. They target the operation's input shape.
224
225/// Error type for the `LogoutError` operation.
226#[non_exhaustive]
227#[derive(::std::fmt::Debug)]
228pub enum LogoutError {
229    /// <p>Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range.</p>
230    InvalidRequestException(crate::types::error::InvalidRequestException),
231    /// <p>Indicates that the request is being made too frequently and is more than what the server can handle.</p>
232    TooManyRequestsException(crate::types::error::TooManyRequestsException),
233    /// <p>Indicates that the request is not authorized. This can happen due to an invalid access token in the request.</p>
234    UnauthorizedException(crate::types::error::UnauthorizedException),
235    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
236    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
237    variable wildcard pattern and check `.code()`:
238     \
239    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
240     \
241    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-LogoutError) for what information is available for the error.")]
242    Unhandled(crate::error::sealed_unhandled::Unhandled),
243}
244impl LogoutError {
245    /// Creates the `LogoutError::Unhandled` variant from any error type.
246    pub fn unhandled(
247        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
248    ) -> Self {
249        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
250            source: err.into(),
251            meta: ::std::default::Default::default(),
252        })
253    }
254
255    /// Creates the `LogoutError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
256    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
257        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
258            source: err.clone().into(),
259            meta: err,
260        })
261    }
262    ///
263    /// Returns error metadata, which includes the error code, message,
264    /// request ID, and potentially additional information.
265    ///
266    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
267        match self {
268            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
269            Self::TooManyRequestsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
270            Self::UnauthorizedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
271            Self::Unhandled(e) => &e.meta,
272        }
273    }
274    /// Returns `true` if the error kind is `LogoutError::InvalidRequestException`.
275    pub fn is_invalid_request_exception(&self) -> bool {
276        matches!(self, Self::InvalidRequestException(_))
277    }
278    /// Returns `true` if the error kind is `LogoutError::TooManyRequestsException`.
279    pub fn is_too_many_requests_exception(&self) -> bool {
280        matches!(self, Self::TooManyRequestsException(_))
281    }
282    /// Returns `true` if the error kind is `LogoutError::UnauthorizedException`.
283    pub fn is_unauthorized_exception(&self) -> bool {
284        matches!(self, Self::UnauthorizedException(_))
285    }
286}
287impl ::std::error::Error for LogoutError {
288    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
289        match self {
290            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
291            Self::TooManyRequestsException(_inner) => ::std::option::Option::Some(_inner),
292            Self::UnauthorizedException(_inner) => ::std::option::Option::Some(_inner),
293            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
294        }
295    }
296}
297impl ::std::fmt::Display for LogoutError {
298    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
299        match self {
300            Self::InvalidRequestException(_inner) => _inner.fmt(f),
301            Self::TooManyRequestsException(_inner) => _inner.fmt(f),
302            Self::UnauthorizedException(_inner) => _inner.fmt(f),
303            Self::Unhandled(_inner) => {
304                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
305                    write!(f, "unhandled error ({code})")
306                } else {
307                    f.write_str("unhandled error")
308                }
309            }
310        }
311    }
312}
313impl ::aws_smithy_types::retry::ProvideErrorKind for LogoutError {
314    fn code(&self) -> ::std::option::Option<&str> {
315        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
316    }
317    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
318        ::std::option::Option::None
319    }
320}
321impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for LogoutError {
322    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
323        match self {
324            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
325            Self::TooManyRequestsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
326            Self::UnauthorizedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
327            Self::Unhandled(_inner) => &_inner.meta,
328        }
329    }
330}
331impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for LogoutError {
332    fn create_unhandled_error(
333        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
334        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
335    ) -> Self {
336        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
337            source,
338            meta: meta.unwrap_or_default(),
339        })
340    }
341}
342impl ::aws_types::request_id::RequestId for crate::operation::logout::LogoutError {
343    fn request_id(&self) -> Option<&str> {
344        self.meta().request_id()
345    }
346}
347
348pub use crate::operation::logout::_logout_output::LogoutOutput;
349
350pub use crate::operation::logout::_logout_input::LogoutInput;
351
352mod _logout_input;
353
354mod _logout_output;
355
356/// Builders
357pub mod builders;
aws_sdk_sso/operation/logout.rs

aws_sdk_sso/operation/
logout.rs
