com.amazonaws.services.cognitoidentityprovider.model

Class AdminDisableUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminDisableUserRequest

All Implemented Interfaces:

Serializable, Cloneable

public class AdminDisableUserRequest
extends AmazonWebServiceRequest
implements Serializable

Disables the specified user.

Calling this action requires developer credentials.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminDisableUserRequest()

Method Summary

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

The user name of the user you wish 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 wish to disable.

setUsername

public void setUsername(String username)

The user name of the user you wish 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 wish to disable.

withUsername

public AdminDisableUserRequest withUsername(String username)

The user name of the user you wish 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 wish to disable.

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