Struct aws_sdk_sso::client::fluent_builders::Logout

pub struct Logout { /* private fields */ }

Fluent builder constructing a request to Logout.

Removes the locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.

If a user uses IAM Identity Center to access the AWS CLI, the user’s IAM Identity Center sign in session is used to obtain an IAM session, as specified in the corresponding IAM Identity Center permission set. More specifically, IAM Identity Center assumes an IAM role in the target account on behalf of the user, and the corresponding temporary AWS credentials are returned to the client.

After user logout, any existing IAM role sessions that were created by using IAM Identity Center permission sets continue based on the duration configured in the permission set. For more information, see User authentications in the IAM Identity Center User Guide.

Implementations

impl Logout

pub async fn customize(
    self
) -> Result<CustomizableOperation<Logout, AwsResponseRetryClassifier>, SdkError<LogoutError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(self) -> Result<LogoutOutput, SdkError<LogoutError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn access_token(self, input: impl Into<String>) -> Self

The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

pub fn set_access_token(self, input: Option<String>) -> Self

The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

Trait Implementations

impl Clone for Logout

fn clone(&self) -> Logout

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Logout

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.