com.amazonaws.services.cognitoidentityprovider.model

Class AdminRemoveUserFromGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminRemoveUserFromGroupRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Removes the specified user from the specified group.

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
AdminRemoveUserFromGroupRequest()

Method Summary

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

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

AdminRemoveUserFromGroupRequest

public AdminRemoveUserFromGroupRequest()

Method Detail

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID for the user pool.

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

Returns:

The user pool ID for the user pool.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool.

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

Parameters:

userPoolId -

The user pool ID for the user pool.

withUserPoolId

public AdminRemoveUserFromGroupRequest withUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool.

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.

Returns:

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

getUsername

public java.lang.String getUsername()

The username for the user.

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

Returns:

The username for the user.

setUsername

public void setUsername(java.lang.String username)

The username for the user.

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

Parameters:

username -

The username for the user.

withUsername

public AdminRemoveUserFromGroupRequest withUsername(java.lang.String username)

The username for the user.

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 username for the user.

Returns:

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

getGroupName

public java.lang.String getGroupName()

The group name.

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

Returns:

The group name.

setGroupName

public void setGroupName(java.lang.String groupName)

The group name.

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

Parameters:

groupName -

The group name.

withGroupName

public AdminRemoveUserFromGroupRequest withGroupName(java.lang.String groupName)

The group 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:

groupName -

The group name.

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