software.amazon.awssdk.services.cognitoidentityprovider.model

Class AdminUpdateUserAttributesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.AdminUpdateUserAttributesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AdminUpdateUserAttributesRequest.Builder,AdminUpdateUserAttributesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class AdminUpdateUserAttributesRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<AdminUpdateUserAttributesRequest.Builder,AdminUpdateUserAttributesRequest>

Represents the request to update the user's attributes as an administrator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdminUpdateUserAttributesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static AdminUpdateUserAttributesRequest.Builder	builder()
Map<String,String>	clientMetadata() A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClientMetadata() Returns true if the ClientMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasUserAttributes() Returns true if the UserAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends AdminUpdateUserAttributesRequest.Builder>	serializableBuilderClass()
AdminUpdateUserAttributesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<AttributeType>	userAttributes() An array of name-value pairs representing user attributes.
String	username() The user name of the user for whom you want to update user attributes.
String	userPoolId() The user pool ID for the user pool where you want to update user attributes.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

userPoolId

public String userPoolId()

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

Returns:

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

username

public String username()

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

Returns:

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

hasUserAttributes

public boolean hasUserAttributes()

Returns true if the UserAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

userAttributes

public List<AttributeType> userAttributes()

An array of name-value pairs representing user attributes.

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasUserAttributes() to see if a value was sent in this field.

Returns:

An array of name-value pairs representing user attributes.

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

hasClientMetadata

public boolean hasClientMetadata()

Returns true if the ClientMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

clientMetadata

public Map<String,String> clientMetadata()

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasClientMetadata() to see if a value was sent in this field.

Returns:

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

toBuilder

public AdminUpdateUserAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdminUpdateUserAttributesRequest.Builder,AdminUpdateUserAttributesRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static AdminUpdateUserAttributesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AdminUpdateUserAttributesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo