Struct aws_sdk_cognitoidentityprovider::operation::global_sign_out::builders::GlobalSignOutFluentBuilder

pub struct GlobalSignOutFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GlobalSignOut.

Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation when your user signs out of your app. This results in the following behavior.

• Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.

  Amazon Cognito returns an Access Token has been revoked error when your app attempts to authorize a user pools API request with a revoked access token that contains the scope aws.cognito.signin.user.admin.

• Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with ServerSideTokenCheck enabled for its user pool IdP configuration in CognitoIdentityProvider.

• Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.

Other requests might be valid until your user's token expires.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Implementations

impl GlobalSignOutFluentBuilder

pub fn as_input(&self) -> &GlobalSignOutInputBuilder

Access the GlobalSignOut as a reference.

pub async fn send( self, ) -> Result<GlobalSignOutOutput, SdkError<GlobalSignOutError, HttpResponse>>

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 customize( self, ) -> CustomizableOperation<GlobalSignOutOutput, GlobalSignOutError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

A valid access token that Amazon Cognito issued to the user who you want to sign out.

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

A valid access token that Amazon Cognito issued to the user who you want to sign out.

pub fn get_access_token(&self) -> &Option<String>

A valid access token that Amazon Cognito issued to the user who you want to sign out.

Trait Implementations

impl Clone for GlobalSignOutFluentBuilder

fn clone(&self) -> GlobalSignOutFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalSignOutFluentBuilder

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

Formats the value using the given formatter.