NAME

Paws::CognitoIdp::ConfirmSignUp - Arguments for method ConfirmSignUp on Paws::CognitoIdp

DESCRIPTION

This class represents the parameters used for calling the method ConfirmSignUp on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method ConfirmSignUp.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ConfirmSignUp.

SYNOPSIS

    my $cognito-idp = Paws->service('CognitoIdp');
    my $ConfirmSignUpResponse = $cognito -idp->ConfirmSignUp(
      ClientId          => 'MyClientIdType',
      ConfirmationCode  => 'MyConfirmationCodeType',
      Username          => 'MyUsernameType',
      AnalyticsMetadata => {
        AnalyticsEndpointId => 'MyStringType',    # OPTIONAL
      },    # OPTIONAL
      ForceAliasCreation => 1,                     # OPTIONAL
      SecretHash         => 'MySecretHashType',    # OPTIONAL
      UserContextData    => {
        EncodedData => 'MyStringType',             # OPTIONAL
      },    # OPTIONAL
    );

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/ConfirmSignUp

ATTRIBUTES

AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType

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

REQUIRED ClientId => Str

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

REQUIRED ConfirmationCode => Str

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

ForceAliasCreation => Bool

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.

SecretHash => Str

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.

UserContextData => Paws::CognitoIdp::UserContextDataType

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

REQUIRED Username => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method ConfirmSignUp in Paws::CognitoIdp

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues