com.amazonaws.services.cognitoidentityprovider.model

Class DeleteUserAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.DeleteUserAttributesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Deletes the attributes for a user.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeleteUserAttributesRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAccessToken() A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
java.util.List<java.lang.String>	getUserAttributeNames() An array of strings representing the user attribute names you want to delete.
int	hashCode()
void	setAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
void	setUserAttributeNames(java.util.Collection<java.lang.String> userAttributeNames) An array of strings representing the user attribute names you want to delete.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteUserAttributesRequest	withAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
DeleteUserAttributesRequest	withUserAttributeNames(java.util.Collection<java.lang.String> userAttributeNames) An array of strings representing the user attribute names you want to delete.
DeleteUserAttributesRequest	withUserAttributeNames(java.lang.String... userAttributeNames) An array of strings representing the user attribute names you want to delete.

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

DeleteUserAttributesRequest

public DeleteUserAttributesRequest()

Method Detail

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 prependattach the custom: prefix to the front of the attribute name.

Returns:

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

For custom attributes, you must prependattach the custom: prefix to the front of 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 prependattach the custom: prefix to the front of the attribute name.

Parameters:

userAttributeNames -

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

For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.

withUserAttributeNames

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

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

For custom attributes, you must prependattach the custom: prefix to the front of 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 prependattach the custom: prefix to the front of the attribute name.

Returns:

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

withUserAttributeNames

public DeleteUserAttributesRequest 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 prependattach the custom: prefix to the front of 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 prependattach the custom: prefix to the front of the attribute name.

Returns:

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

getAccessToken

public java.lang.String getAccessToken()

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Returns:

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

setAccessToken

public void setAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

withAccessToken

public DeleteUserAttributesRequest withAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

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

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

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