CognitoIdentityProvider / Client / confirm_sign_up

confirm_sign_up

CognitoIdentityProvider.Client.confirm_sign_up(**kwargs)

Confirms registration of a new user.

See also: AWS API Documentation

Request Syntax

response = client.confirm_sign_up(
    ClientId='string',
    SecretHash='string',
    Username='string',
    ConfirmationCode='string',
    ForceAliasCreation=True|False,
    AnalyticsMetadata={
        'AnalyticsEndpointId': 'string'
    },
    UserContextData={
        'IpAddress': 'string',
        'EncodedData': 'string'
    },
    ClientMetadata={
        'string': 'string'
    }
)

Parameters:

• ClientId (string) –

  [REQUIRED]

  The ID of the app client associated with the user pool.

• SecretHash (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.

• Username (string) –

  [REQUIRED]

  The user name of the user whose registration you want to confirm.

• ConfirmationCode (string) –

  [REQUIRED]

  The confirmation code sent by a user’s request to confirm registration.

• ForceAliasCreation (boolean) – 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.

• AnalyticsMetadata (dict) –

  The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

  • AnalyticsEndpointId (string) –

    The endpoint ID.

• UserContextData (dict) –

  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.

  • IpAddress (string) –

    The source IP address of your user’s device.

  • EncodedData (string) –

    Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

• ClientMetadata (dict) –

  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.

  Note

  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.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

  Represents the response from the server for the registration confirmation.

Exceptions

• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

• CognitoIdentityProvider.Client.exceptions.InvalidParameterException

• CognitoIdentityProvider.Client.exceptions.UnexpectedLambdaException

• CognitoIdentityProvider.Client.exceptions.UserLambdaValidationException

• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

• CognitoIdentityProvider.Client.exceptions.TooManyFailedAttemptsException

• CognitoIdentityProvider.Client.exceptions.CodeMismatchException

• CognitoIdentityProvider.Client.exceptions.ExpiredCodeException

• CognitoIdentityProvider.Client.exceptions.InvalidLambdaResponseException

• CognitoIdentityProvider.Client.exceptions.AliasExistsException

• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

• CognitoIdentityProvider.Client.exceptions.LimitExceededException

• CognitoIdentityProvider.Client.exceptions.UserNotFoundException

• CognitoIdentityProvider.Client.exceptions.InternalErrorException

• CognitoIdentityProvider.Client.exceptions.ForbiddenException