software.amazon.awssdk.services.cognitoidentityprovider.model

Class AdminConfirmSignUpRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AdminConfirmSignUpRequest.Builder,AdminConfirmSignUpRequest>

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

Represents the request to confirm user registration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdminConfirmSignUpRequest.Builder

Method Summary

Modifier and Type	Method and Description
static AdminConfirmSignUpRequest.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() For responses, this returns true if the service returned a value for the ClientMetadata property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AdminConfirmSignUpRequest.Builder>	serializableBuilderClass()
AdminConfirmSignUpRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	username() The user name for which you want to confirm user registration.
String	userPoolId() The user pool ID for which you want to confirm user registration.

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 final String userPoolId()

The user pool ID for which you want to confirm user registration.

Returns:

The user pool ID for which you want to confirm user registration.

username

public final String username()

The user name for which you want to confirm user registration.

Returns:

The user name for which you want to confirm user registration.

hasClientMetadata

public final boolean hasClientMetadata()

For responses, this returns true if the service returned a value for the ClientMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

clientMetadata

public final 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.

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in 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.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClientMetadata() method.

Returns:

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

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in 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.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

toBuilder

public AdminConfirmSignUpRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdminConfirmSignUpRequest.Builder,AdminConfirmSignUpRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static AdminConfirmSignUpRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo