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

aws_sdk_sso/operation/
logout.rs
