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_api::client::interceptors::SharedInterceptor::permanent(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default()))
97.with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(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                        #[allow(clippy::uninlined_format_args)]
136fn uri_base(_input: &crate::operation::logout::LogoutInput, output: &mut ::std::string::String) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
137    use ::std::fmt::Write as _;
138    ::std::write!(output, "/logout").expect("formatting should succeed");
139    ::std::result::Result::Ok(())
140}
141#[allow(clippy::unnecessary_wraps)]
142fn update_http_builder(
143                input: &crate::operation::logout::LogoutInput,
144                builder: ::http_1x::request::Builder
145            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
146    let mut uri = ::std::string::String::new();
147    uri_base(input, &mut uri)?;
148    let builder = crate::protocol_serde::shape_logout::ser_logout_headers(input, builder)?;
149    ::std::result::Result::Ok(builder.method("POST").uri(uri))
150}
151let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
152builder
153                    };
154                    let body = ::aws_smithy_types::body::SdkBody::from("");
155                    
156                    ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
157                }
158            }
159#[derive(Debug)]
160            struct LogoutEndpointParamsInterceptor;
161
162            #[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
163            impl ::aws_smithy_runtime_api::client::interceptors::Intercept for LogoutEndpointParamsInterceptor {
164                fn name(&self) -> &'static str {
165                    "LogoutEndpointParamsInterceptor"
166                }
167
168                fn read_before_execution(
169                    &self,
170                    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>,
171                    cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
172                ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
173                    let _input = context.input()
174                        .downcast_ref::<LogoutInput>()
175                        .ok_or("failed to downcast to LogoutInput")?;
176
177                    
178
179                    let params = crate::config::endpoint::Params::builder()
180                        .set_region(cfg.load::<::aws_types::region::Region>().map(|r|r.as_ref().to_owned()))
181.set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
182.set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
183.set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
184                        .build()
185                        .map_err(|err| ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err))?;
186                    cfg.interceptor_state().store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
187                    ::std::result::Result::Ok(())
188                }
189            }
190
191            // The get_* functions below are generated from JMESPath expressions in the
192            // operationContextParams trait. They target the operation's input shape.
193
194            
195
196/// Error type for the `LogoutError` operation.
197#[non_exhaustive]
198#[derive(::std::fmt::Debug)]
199pub enum LogoutError {
200    /// <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>
201    InvalidRequestException(crate::types::error::InvalidRequestException),
202    /// <p>Indicates that the request is being made too frequently and is more than what the server can handle.</p>
203    TooManyRequestsException(crate::types::error::TooManyRequestsException),
204    /// <p>Indicates that the request is not authorized. This can happen due to an invalid access token in the request.</p>
205    UnauthorizedException(crate::types::error::UnauthorizedException),
206    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
207                    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
208    variable wildcard pattern and check `.code()`:
209     \
210    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
211     \
212    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-LogoutError) for what information is available for the error.")]
213                    Unhandled(crate::error::sealed_unhandled::Unhandled),
214}
215impl LogoutError {
216    /// Creates the `LogoutError::Unhandled` variant from any error type.
217                    pub fn unhandled(err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>) -> Self {
218                        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source: err.into(), meta: ::std::default::Default::default() })
219                    }
220    
221                    /// Creates the `LogoutError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
222                    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
223                        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source: err.clone().into(), meta: err })
224                    }
225    /// 
226    /// Returns error metadata, which includes the error code, message,
227    /// request ID, and potentially additional information.
228    /// 
229    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
230        match self {
231            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
232            Self::TooManyRequestsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
233            Self::UnauthorizedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
234            Self::Unhandled(e) => &e.meta,
235        }
236    }
237    /// Returns `true` if the error kind is `LogoutError::InvalidRequestException`.
238    pub fn is_invalid_request_exception(&self) -> bool {
239        matches!(self, Self::InvalidRequestException(_))
240    }
241    /// Returns `true` if the error kind is `LogoutError::TooManyRequestsException`.
242    pub fn is_too_many_requests_exception(&self) -> bool {
243        matches!(self, Self::TooManyRequestsException(_))
244    }
245    /// Returns `true` if the error kind is `LogoutError::UnauthorizedException`.
246    pub fn is_unauthorized_exception(&self) -> bool {
247        matches!(self, Self::UnauthorizedException(_))
248    }
249}
250impl ::std::error::Error for LogoutError {
251    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
252        match self {
253            Self::InvalidRequestException(_inner) =>
254            ::std::option::Option::Some(_inner)
255            ,
256            Self::TooManyRequestsException(_inner) =>
257            ::std::option::Option::Some(_inner)
258            ,
259            Self::UnauthorizedException(_inner) =>
260            ::std::option::Option::Some(_inner)
261            ,
262            Self::Unhandled(_inner) => {
263                ::std::option::Option::Some(&*_inner.source)
264            }
265        }
266    }
267}
268impl ::std::fmt::Display for LogoutError {
269    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
270        match self {
271            Self::InvalidRequestException(_inner) =>
272            _inner.fmt(f)
273            ,
274            Self::TooManyRequestsException(_inner) =>
275            _inner.fmt(f)
276            ,
277            Self::UnauthorizedException(_inner) =>
278            _inner.fmt(f)
279            ,
280            Self::Unhandled(_inner) => {
281                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
282                                                        write!(f, "unhandled error ({code})")
283                                                    } else {
284                                                        f.write_str("unhandled error")
285                                                    }
286            }
287        }
288    }
289}
290impl ::aws_smithy_types::retry::ProvideErrorKind for LogoutError {
291    fn code(&self) -> ::std::option::Option<&str> {
292        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
293    }
294    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
295        ::std::option::Option::None
296    }
297}
298impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for LogoutError {
299    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
300        match self {
301            Self::InvalidRequestException(_inner) =>
302            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
303            ,
304            Self::TooManyRequestsException(_inner) =>
305            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
306            ,
307            Self::UnauthorizedException(_inner) =>
308            ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
309            ,
310            Self::Unhandled(_inner) => {
311                &_inner.meta
312            }
313        }
314    }
315}
316impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for LogoutError {
317    fn create_unhandled_error(
318                        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
319                        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>
320                    ) -> Self {
321        Self::Unhandled(crate::error::sealed_unhandled::Unhandled { source, meta: meta.unwrap_or_default() })
322    }
323}
324impl ::aws_types::request_id::RequestId for crate::operation::logout::LogoutError {
325                                fn request_id(&self) -> Option<&str> {
326                                    self.meta().request_id()
327                                }
328                            }
329
330pub use crate::operation::logout::_logout_input::LogoutInput;
331
332pub use crate::operation::logout::_logout_output::LogoutOutput;
333
334mod _logout_input;
335
336mod _logout_output;
337
338/// Builders
339pub mod builders;
340
aws_sdk_sso/operation/logout.rs

aws_sdk_sso/operation/
logout.rs
