com.amazonaws.services.cognitoidentityprovider.model

Class AdminDeleteUserAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminDeleteUserAttributesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Deletes the user attributes in a user pool as an administrator. Works on any user.

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	getUserAttributeNames() An array of strings representing the user attribute names you want to delete.
java.lang.String	getUsername() The user name of the user from which you would like to delete attributes.
java.lang.String	getUserPoolId() The user pool ID for the user pool where you want to delete user attributes.
int	hashCode()
void	setUserAttributeNames(java.util.Collection<java.lang.String> userAttributeNames) An array of strings representing the user attribute names you want to delete.
void	setUsername(java.lang.String username) The user name of the user from which you would like to delete attributes.
void	setUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool where you want to delete user attributes.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminDeleteUserAttributesRequest	withUserAttributeNames(java.util.Collection<java.lang.String> userAttributeNames) An array of strings representing the user attribute names you want to delete.
AdminDeleteUserAttributesRequest	withUserAttributeNames(java.lang.String... userAttributeNames) An array of strings representing the user attribute names you want to delete.
AdminDeleteUserAttributesRequest	withUsername(java.lang.String username) The user name of the user from which you would like to delete attributes.
AdminDeleteUserAttributesRequest	withUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool where you want to delete 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

AdminDeleteUserAttributesRequest

public AdminDeleteUserAttributesRequest()

Method Detail

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID for the user pool where you want to delete 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 delete user attributes.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool where you want to delete 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 delete user attributes.

withUserPoolId

public AdminDeleteUserAttributesRequest withUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool where you want to delete 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 delete user attributes.

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 from which you would like to delete attributes.

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

Returns:

The user name of the user from which you would like to delete attributes.

setUsername

public void setUsername(java.lang.String username)

The user name of the user from which you would like to delete attributes.

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

Parameters:

username -

The user name of the user from which you would like to delete attributes.

withUsername

public AdminDeleteUserAttributesRequest withUsername(java.lang.String username)

The user name of the user from which you would like to delete 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 from which you would like to delete attributes.

Returns:

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

getUserAttributeNames

public java.util.List<java.lang.String> getUserAttributeNames()

An array of strings representing the user attribute names you want to delete.

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

Returns:

An array of strings representing the user attribute names you want to delete.

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

setUserAttributeNames

public void setUserAttributeNames(java.util.Collection<java.lang.String> userAttributeNames)

An array of strings representing the user attribute names you want to delete.

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

Parameters:

userAttributeNames -

An array of strings representing the user attribute names you want to delete.

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

withUserAttributeNames

public AdminDeleteUserAttributesRequest withUserAttributeNames(java.lang.String... userAttributeNames)

An array of strings representing the user attribute names you want to delete.

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:

userAttributeNames -

An array of strings representing the user attribute names you want to delete.

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.

withUserAttributeNames

public AdminDeleteUserAttributesRequest withUserAttributeNames(java.util.Collection<java.lang.String> userAttributeNames)

An array of strings representing the user attribute names you want to delete.

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:

userAttributeNames -

An array of strings representing the user attribute names you want to delete.

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 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