Class ConfirmSignUpRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ConfirmSignUpRequest.Builder,
ConfirmSignUpRequest>
Represents the request to confirm registration of a user.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AnalyticsMetadataType
Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID.static ConfirmSignUpRequest.Builder
builder()
final String
clientId()
The ID of the app client associated with the user pool.A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.final String
The confirmation code that your user pool sent in response to theSignUp
request.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Whentrue
, forces user confirmation despite any existing aliases.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the ClientMetadata property.final int
hashCode()
final String
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.static Class
<? extends ConfirmSignUpRequest.Builder> final String
session()
The optional session ID from aSignUp
API request.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final UserContextDataType
Contextual data about your user session like the device fingerprint, IP address, or location.final String
username()
The name of the user that you want to query or modify.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clientId
The ID of the app client associated with the user pool.
- Returns:
- The ID of the app client associated with the user pool.
-
secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about
SecretHash
, see Computing secret hash values.- Returns:
- A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and
username plus the client ID in the message. For more information about
SecretHash
, see Computing secret hash values.
-
username
The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If
username
isn't an alias attribute in your user pool, this value must be thesub
of a local user or the username of a user from a third-party IdP.- Returns:
- The name of the user that you want to query or modify. The value of this parameter is typically your
user's username, but it can be any of their alias attributes. If
username
isn't an alias attribute in your user pool, this value must be thesub
of a local user or the username of a user from a third-party IdP.
-
confirmationCode
The confirmation code that your user pool sent in response to the
SignUp
request.- Returns:
- The confirmation code that your user pool sent in response to the
SignUp
request.
-
forceAliasCreation
When
true
, forces user confirmation despite any existing aliases. Defaults tofalse
. A value oftrue
migrates the alias from an existing user to the new user if an existing user already has the phone number or email address as an alias.Say, for example, that an existing user has an
email
attribute ofbob@example.com
and email is an alias in your user pool. If the new user also has an email ofbob@example.com
and yourConfirmSignUp
response setsForceAliasCreation
totrue
, the new user can sign in with a username ofbob@example.com
and the existing user can no longer do so.If
false
and an attribute belongs to an existing alias, this request returns an AliasExistsException error.For more information about sign-in aliases, see Customizing sign-in attributes.
- Returns:
- When
true
, forces user confirmation despite any existing aliases. Defaults tofalse
. A value oftrue
migrates the alias from an existing user to the new user if an existing user already has the phone number or email address as an alias.Say, for example, that an existing user has an
email
attribute ofbob@example.com
and email is an alias in your user pool. If the new user also has an email ofbob@example.com
and yourConfirmSignUp
response setsForceAliasCreation
totrue
, the new user can sign in with a username ofbob@example.com
and the existing user can no longer do so.If
false
and an attribute belongs to an existing alias, this request returns an AliasExistsException error.For more information about sign-in aliases, see Customizing sign-in attributes.
-
analyticsMetadata
Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
- Returns:
- Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
-
userContextData
Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
For more information, see Collecting data for threat protection in applications.
- Returns:
- Contextual data about your user session like the device fingerprint, IP address, or location. Amazon
Cognito threat protection evaluates the risk of an authentication event based on the context that your
app generates and passes to Amazon Cognito when it makes API requests.
For more information, see Collecting data for threat protection in applications.
-
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 theisEmpty()
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
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 Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation 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 ConfirmSignUp request. In your function code in Lambda, you can process theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.
When you use the
ClientMetadata
parameter, note 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, theClientMetadata
parameter serves no purpose. -
Validate the
ClientMetadata
value. -
Encrypt the
ClientMetadata
value. Don't send sensitive information in this parameter.
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.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation 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 ConfirmSignUp request. In your function code in Lambda, you can process theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.
When you use the
ClientMetadata
parameter, note 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, theClientMetadata
parameter serves no purpose. -
Validate the
ClientMetadata
value. -
Encrypt the
ClientMetadata
value. Don't send sensitive information in this parameter.
-
-
-
session
The optional session ID from a
SignUp
API request. You can sign in a user directly from the sign-up process with theUSER_AUTH
authentication flow.- Returns:
- The optional session ID from a
SignUp
API request. You can sign in a user directly from the sign-up process with theUSER_AUTH
authentication flow.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ConfirmSignUpRequest.Builder,
ConfirmSignUpRequest> - Specified by:
toBuilder
in classCognitoIdentityProviderRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-