com.amazonaws.services.cognitoidentityprovider.model

Class AdminDisableUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminDisableUserRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AdminDisableUserRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to GetUser and ListUsers API requests.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminDisableUserRequest()

Method Summary

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

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

AdminDisableUserRequest

public AdminDisableUserRequest()

Method Detail

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID for the user pool where you want to disable the user.

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

Returns:

The user pool ID for the user pool where you want to disable the user.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool where you want to disable the user.

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

Parameters:

userPoolId -

The user pool ID for the user pool where you want to disable the user.

withUserPoolId

public AdminDisableUserRequest withUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool where you want to disable the user.

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 for the user pool where you want to disable the user.

Returns:

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

getUsername

public java.lang.String getUsername()

The user name of the user you want to disable.

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

Returns:

The user name of the user you want to disable.

setUsername

public void setUsername(java.lang.String username)

The user name of the user you want to disable.

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

Parameters:

username -

The user name of the user you want to disable.

withUsername

public AdminDisableUserRequest withUsername(java.lang.String username)

The user name of the user you want to disable.

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 of the user you want to disable.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object