Paws::CognitoIdp::SignUp - Arguments for method SignUp on Paws::CognitoIdp
This class represents the parameters used for calling the method SignUp on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method SignUp.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SignUp.
my $cognito-idp = Paws->service('CognitoIdp'); my $SignUpResponse = $cognito -idp->SignUp( ClientId => 'MyClientIdType', Password => 'MyPasswordType', Username => 'MyUsernameType', AnalyticsMetadata => { AnalyticsEndpointId => 'MyStringType', # OPTIONAL }, # OPTIONAL SecretHash => 'MySecretHashType', # OPTIONAL UserAttributes => [ { Name => 'MyAttributeNameType', # min: 1, max: 32 Value => 'MyAttributeValueType', # max: 2048; OPTIONAL }, ... ], # OPTIONAL UserContextData => { EncodedData => 'MyStringType', # OPTIONAL }, # OPTIONAL ValidationData => [ { Name => 'MyAttributeNameType', # min: 1, max: 32 Value => 'MyAttributeValueType', # max: 2048; OPTIONAL }, ... ], # OPTIONAL ); # Results: my $CodeDeliveryDetails = $SignUpResponse->CodeDeliveryDetails; my $UserConfirmed = $SignUpResponse->UserConfirmed; my $UserSub = $SignUpResponse->UserSub; # Returns a L<Paws::CognitoIdp::SignUpResponse> object.
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/SignUp
The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
SignUp
The ID of the client associated with the user pool.
The password of the user you wish to register.
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.
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
custom:
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.
The user name of the user you wish to register.
The validation data in the request to register a user.
This class forms part of Paws, documenting arguments for method SignUp in Paws::CognitoIdp
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
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.