com.amazonaws.services.cognitoidentityprovider.model

Class GlobalSignOutRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.GlobalSignOutRequest

All Implemented Interfaces:

Serializable, Cloneable

public class GlobalSignOutRequest
extends AmazonWebServiceRequest
implements Serializable

Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GlobalSignOutRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccessToken() The access token.
int	hashCode()
void	setAccessToken(String accessToken) The access token.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GlobalSignOutRequest	withAccessToken(String accessToken) The access token.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlobalSignOutRequest

public GlobalSignOutRequest()

Method Detail

getAccessToken

public String getAccessToken()

The access token.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Returns:

The access token.

setAccessToken

public void setAccessToken(String accessToken)

The access token.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

The access token.

withAccessToken

public GlobalSignOutRequest withAccessToken(String accessToken)

The access token.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

The access token.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object