com.amazonaws.services.cognitoidentityprovider.model

Class AdminUserGlobalSignOutRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminUserGlobalSignOutRequest

All Implemented Interfaces:

Serializable, Cloneable

public class AdminUserGlobalSignOutRequest
extends AmazonWebServiceRequest
implements Serializable

Signs out users from all devices, as an administrator. 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.

Calling this action requires developer credentials.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminUserGlobalSignOutRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getUsername() The user name.
String	getUserPoolId() The user pool ID.
int	hashCode()
void	setUsername(String username) The user name.
void	setUserPoolId(String userPoolId) The user pool ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminUserGlobalSignOutRequest	withUsername(String username) The user name.
AdminUserGlobalSignOutRequest	withUserPoolId(String userPoolId) The user pool ID.

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

AdminUserGlobalSignOutRequest

public AdminUserGlobalSignOutRequest()

Method Detail

getUserPoolId

public String getUserPoolId()

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The user pool ID.

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID.

withUserPoolId

public AdminUserGlobalSignOutRequest withUserPoolId(String userPoolId)

The user pool ID.

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID.

Returns:

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

getUsername

public String getUsername()

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The user name.

setUsername

public void setUsername(String username)

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name.

withUsername

public AdminUserGlobalSignOutRequest withUsername(String username)

The user name.

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name.

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