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

aws_sdk_sso/operation/
logout.rs
