Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class SignUpResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.SignUpResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SignUpResponse.Builder,SignUpResponse>

@Generated("software.amazon.awssdk:codegen")
public final class SignUpResponse
extends CognitoIdentityProviderResponse
implements ToCopyableBuilder<SignUpResponse.Builder,SignUpResponse>

The response from the server for a registration request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SignUpResponse.Builder

Method Summary

Modifier and Type	Method	Description
static SignUpResponse.Builder	builder()
CodeDeliveryDetailsType	codeDeliveryDetails()	In user pools that automatically verify and confirm new users, Amazon Cognito sends users a message with a code or link that confirms ownership of the phone number or email address that they entered.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SignUpResponse.Builder>	serializableBuilderClass()
String	session()	A session Id that you can pass to ConfirmSignUp when you want to immediately sign in your user with the USER_AUTH flow after they complete sign-up.
SignUpResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	userConfirmed()	Indicates whether the user was automatically confirmed.
String	userSub()	The unique identifier of the new user, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

userConfirmed

public final Boolean userConfirmed()

Indicates whether the user was automatically confirmed. You can auto-confirm users with a pre sign-up Lambda trigger.

Returns:

Indicates whether the user was automatically confirmed. You can auto-confirm users with a pre sign-up Lambda trigger.

codeDeliveryDetails

public final CodeDeliveryDetailsType codeDeliveryDetails()

In user pools that automatically verify and confirm new users, Amazon Cognito sends users a message with a code or link that confirms ownership of the phone number or email address that they entered. The CodeDeliveryDetails object is information about the delivery destination for that link or code.

Returns:

In user pools that automatically verify and confirm new users, Amazon Cognito sends users a message with a code or link that confirms ownership of the phone number or email address that they entered. The CodeDeliveryDetails object is information about the delivery destination for that link or code.

userSub

public final String userSub()

The unique identifier of the new user, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

Returns:

The unique identifier of the new user, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

session

public final String session()

A session Id that you can pass to ConfirmSignUp when you want to immediately sign in your user with the USER_AUTH flow after they complete sign-up.

Returns:

A session Id that you can pass to ConfirmSignUp when you want to immediately sign in your user with the USER_AUTH flow after they complete sign-up.

toBuilder

public SignUpResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SignUpResponse.Builder,SignUpResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static SignUpResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo