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

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

Syntax

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

Description

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

Parameters

-AnalyticsMetadata_AnalyticsEndpointId <String>
The endpoint ID.
Required?False
Position?Named
Accept pipeline input?False
-ClientId <String>
The ID of the client associated with the user pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientMetadata <Hashtable>
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 AWS Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp request. In your function code in AWS 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.Take the following limitations into consideration when you use the ClientMetadata parameter:
  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
  • Amazon Cognito does not validate the ClientMetadata value.
  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
Required?False
Position?Named
Accept pipeline input?False
-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
AliasesUserAttributes
-UserContextData_EncodedData <String>
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?False
Position?Named
Accept pipeline input?False
-Username <String>
The user name of the user you wish to register.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-ValidationData <AttributeType[]>
The validation data in the request to register a user.
Required?False
Position?Named
Accept pipeline input?False

Inputs

You can pipe a String object to this cmdlet for the Username parameter.

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