/

POST

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ClientId": "string",
    "SecretHash": "string",
    "Username": "string",
    "Password": "string",
    "UserAttributes": [],
    "ValidationData": [],
    "AnalyticsMetadata": {},
    "UserContextData": {
        "IpAddress": "string",
        "EncodedData": "string"
    },
    "ClientMetadata": {
        "property1": "string",
        "property2": "string"
    }
}'

Response Example

200 - Example 1

{
    "UserConfirmed": true,
    "CodeDeliveryDetails": {
        "Destination": "string",
        "DeliveryMedium": "SMS",
        "AttributeName": "string"
    },
    "UserSub": "string"
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482UnexpectedLambdaException

🟠483UserLambdaValidationException

🟠484NotAuthorizedException

🟠485InvalidPasswordException

🟠486InvalidLambdaResponseException

🟠487UsernameExistsException

🟠488TooManyRequestsException

🟠489InternalErrorException

🟠490InvalidSmsRoleAccessPolicyException

🟠491InvalidSmsRoleTrustRelationshipException

🟠492InvalidEmailRoleAccessPolicyException

🟠493CodeDeliveryFailureException

🟠494ForbiddenException

Modified at 2023-08-15 07:11:07