/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cognitoidp.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* Represents the request to confirm registration of a user. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ConfirmSignUpRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** The ID of the app client associated with the user pool. *
*/ private String clientId; /** ** 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. *
*/ private String secretHash; /** ** The user name of the user whose registration you want to confirm. *
*/ private String username; /** ** The confirmation code sent by a user's request to confirm registration. *
*/ private String confirmationCode; /** *
* Boolean to be specified to force user confirmation irrespective of existing alias. By default set to
* False
. If this parameter is set to True
and the phone number/email used for sign up
* confirmation already exists as an alias with a different user, the API call will migrate the alias from the
* previous user to the newly created user being confirmed. If set to False
, the API will throw an
* AliasExistsException error.
*
* The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp
calls.
*
* Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito * advanced security 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. *
*/ private UserContextDataType userContextData; /** ** 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 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. *
** The ID of the app client associated with the user pool. *
* * @param clientId * The ID of the app client associated with the user pool. */ public void setClientId(String clientId) { this.clientId = clientId; } /** ** The ID of the app client associated with the user pool. *
* * @return The ID of the app client associated with the user pool. */ public String getClientId() { return this.clientId; } /** ** The ID of the app client associated with the user pool. *
* * @param clientId * The ID of the app client associated with the user pool. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfirmSignUpRequest withClientId(String clientId) { setClientId(clientId); return this; } /** ** 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. *
* * @param 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. */ public void setSecretHash(String secretHash) { this.secretHash = 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. *
* * @return 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. */ public String getSecretHash() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfirmSignUpRequest withSecretHash(String secretHash) { setSecretHash(secretHash); return this; } /** ** The user name of the user whose registration you want to confirm. *
* * @param username * The user name of the user whose registration you want to confirm. */ public void setUsername(String username) { this.username = username; } /** ** The user name of the user whose registration you want to confirm. *
* * @return The user name of the user whose registration you want to confirm. */ public String getUsername() { return this.username; } /** ** The user name of the user whose registration you want to confirm. *
* * @param username * The user name of the user whose registration you want to confirm. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfirmSignUpRequest withUsername(String username) { setUsername(username); return this; } /** ** The confirmation code sent by a user's request to confirm registration. *
* * @param confirmationCode * The confirmation code sent by a user's request to confirm registration. */ public void setConfirmationCode(String confirmationCode) { this.confirmationCode = confirmationCode; } /** ** The confirmation code sent by a user's request to confirm registration. *
* * @return The confirmation code sent by a user's request to confirm registration. */ public String getConfirmationCode() { return this.confirmationCode; } /** ** The confirmation code sent by a user's request to confirm registration. *
* * @param confirmationCode * The confirmation code sent by a user's request to confirm registration. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfirmSignUpRequest withConfirmationCode(String confirmationCode) { setConfirmationCode(confirmationCode); return this; } /** *
* Boolean to be specified to force user confirmation irrespective of existing alias. By default set to
* False
. If this parameter is set to True
and the phone number/email used for sign up
* confirmation already exists as an alias with a different user, the API call will migrate the alias from the
* previous user to the newly created user being confirmed. If set to False
, the API will throw an
* AliasExistsException error.
*
False
. If this parameter is set to True
and the phone number/email used for sign
* up confirmation already exists as an alias with a different user, the API call will migrate the alias from
* the previous user to the newly created user being confirmed. If set to False
, the API will
* throw an AliasExistsException error.
*/
public void setForceAliasCreation(Boolean forceAliasCreation) {
this.forceAliasCreation = forceAliasCreation;
}
/**
*
* Boolean to be specified to force user confirmation irrespective of existing alias. By default set to
* False
. If this parameter is set to True
and the phone number/email used for sign up
* confirmation already exists as an alias with a different user, the API call will migrate the alias from the
* previous user to the newly created user being confirmed. If set to False
, the API will throw an
* AliasExistsException error.
*
False
. If this parameter is set to True
and the phone number/email used for
* sign up confirmation already exists as an alias with a different user, the API call will migrate the
* alias from the previous user to the newly created user being confirmed. If set to False
, the
* API will throw an AliasExistsException error.
*/
public Boolean getForceAliasCreation() {
return this.forceAliasCreation;
}
/**
*
* Boolean to be specified to force user confirmation irrespective of existing alias. By default set to
* False
. If this parameter is set to True
and the phone number/email used for sign up
* confirmation already exists as an alias with a different user, the API call will migrate the alias from the
* previous user to the newly created user being confirmed. If set to False
, the API will throw an
* AliasExistsException error.
*
False
. If this parameter is set to True
and the phone number/email used for sign
* up confirmation already exists as an alias with a different user, the API call will migrate the alias from
* the previous user to the newly created user being confirmed. If set to False
, the API will
* throw an AliasExistsException error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfirmSignUpRequest withForceAliasCreation(Boolean forceAliasCreation) {
setForceAliasCreation(forceAliasCreation);
return this;
}
/**
*
* Boolean to be specified to force user confirmation irrespective of existing alias. By default set to
* False
. If this parameter is set to True
and the phone number/email used for sign up
* confirmation already exists as an alias with a different user, the API call will migrate the alias from the
* previous user to the newly created user being confirmed. If set to False
, the API will throw an
* AliasExistsException error.
*
False
. If this parameter is set to True
and the phone number/email used for
* sign up confirmation already exists as an alias with a different user, the API call will migrate the
* alias from the previous user to the newly created user being confirmed. If set to False
, the
* API will throw an AliasExistsException error.
*/
public Boolean isForceAliasCreation() {
return this.forceAliasCreation;
}
/**
*
* The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp
calls.
*
ConfirmSignUp
calls.
*/
public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) {
this.analyticsMetadata = analyticsMetadata;
}
/**
*
* The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp
calls.
*
ConfirmSignUp
calls.
*/
public AnalyticsMetadataType getAnalyticsMetadata() {
return this.analyticsMetadata;
}
/**
*
* The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp
calls.
*
ConfirmSignUp
calls.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfirmSignUpRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) {
setAnalyticsMetadata(analyticsMetadata);
return this;
}
/**
* * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito * advanced security 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. *
* * @param userContextData * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon * Cognito advanced security 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. */ public void setUserContextData(UserContextDataType userContextData) { this.userContextData = userContextData; } /** ** Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito * advanced security 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. *
* * @return Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon * Cognito advanced security 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. */ public UserContextDataType getUserContextData() { return this.userContextData; } /** ** Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito * advanced security 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. *
* * @param userContextData * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon * Cognito advanced security 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfirmSignUpRequest withUserContextData(UserContextDataType userContextData) { setUserContextData(userContextData); return this; } /** ** 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 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. *
*
* 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 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. *
** 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 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. *
*
* 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 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. *
** 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 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. *
*
* 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 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. *
*