AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the SignUp operation against Amazon Cognito Identity Provider. This operation uses anonymous authentication and does not require credential parameters to be supplied.

Syntax

Register-CGIPUserInPool
-ClientId <String>
-Password <String>
-SecretHash <String>
-UserAttribute <AttributeType[]>
-Username <String>
-ValidationData <AttributeType[]>
-Force <SwitchParameter>

Description

Registers the user in the specified user pool and creates a user name, password, and user attributes.

Parameters

-ClientId <String>
The ID of the client associated with the user pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-Password <String>
The password of the user you wish to register.
Required?False
Position?Named
Accept pipeline input?False
-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.
Required?False
Position?Named
Accept pipeline input?False
-UserAttribute <AttributeType[]>
An array of name-value pairs representing user attributes.For custom attributes, you must prepend the custom: prefix to the attribute name.
Required?False
Position?Named
Accept pipeline input?False
-Username <String>
The user name of the user you wish to register.
Required?False
Position?Named
Accept pipeline input?False
-ValidationData <AttributeType[]>
The validation data in the request to register a user.
Required?False
Position?Named
Accept pipeline input?False

Inputs

This cmdlet does not accept pipeline input.

Outputs

This cmdlet returns a Amazon.CognitoIdentityProvider.Model.SignUpResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z