com.amazonaws.services.cognitoidentityprovider.model

Class AdminUpdateUserAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminUpdateUserAttributesRequest

All Implemented Interfaces:

Serializable, Cloneable

public class AdminUpdateUserAttributesRequest
extends AmazonWebServiceRequest
implements Serializable

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

For custom attributes, you must prepend the custom: prefix to the attribute name.

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

Requires developer credentials.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminUpdateUserAttributesRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<AttributeType>	getUserAttributes() An array of name-value pairs representing user attributes.
String	getUsername() The user name of the user for whom you want to update user attributes.
String	getUserPoolId() The user pool ID for the user pool where you want to update user attributes.
int	hashCode()
void	setUserAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
void	setUsername(String username) The user name of the user for whom you want to update user attributes.
void	setUserPoolId(String userPoolId) The user pool ID for the user pool where you want to update user attributes.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminUpdateUserAttributesRequest	withUserAttributes(AttributeType... userAttributes) An array of name-value pairs representing user attributes.
AdminUpdateUserAttributesRequest	withUserAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
AdminUpdateUserAttributesRequest	withUsername(String username) The user name of the user for whom you want to update user attributes.
AdminUpdateUserAttributesRequest	withUserPoolId(String userPoolId) The user pool ID for the user pool where you want to update user attributes.

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

AdminUpdateUserAttributesRequest

public AdminUpdateUserAttributesRequest()

Method Detail

getUserPoolId

public String getUserPoolId()

The user pool ID for the user pool where you want to update user attributes.

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

Returns:

The user pool ID for the user pool where you want to update user attributes.

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID for the user pool where you want to update user attributes.

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

Parameters:

userPoolId -

The user pool ID for the user pool where you want to update user attributes.

withUserPoolId

public AdminUpdateUserAttributesRequest withUserPoolId(String userPoolId)

The user pool ID for the user pool where you want to update user attributes.

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 update user attributes.

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 for whom you want to update user attributes.

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

Returns:

The user name of the user for whom you want to update user attributes.

setUsername

public void setUsername(String username)

The user name of the user for whom you want to update user attributes.

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

Parameters:

username -

The user name of the user for whom you want to update user attributes.

withUsername

public AdminUpdateUserAttributesRequest withUsername(String username)

The user name of the user for whom you want to update user attributes.

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 for whom you want to update user attributes.

Returns:

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

getUserAttributes

public List<AttributeType> getUserAttributes()

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

setUserAttributes

public void setUserAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Parameters:

userAttributes -

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

withUserAttributes

public AdminUpdateUserAttributesRequest withUserAttributes(AttributeType... userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

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

Parameters:

userAttributes -

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

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

withUserAttributes

public AdminUpdateUserAttributesRequest withUserAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

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

Parameters:

userAttributes -

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute 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