An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message).

For custom attributes, you must prepend the custom: prefix to the attribute name.

To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling AdminUpdateUserAttributes.

email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.

","ValidationData",{"_3172":3194},[3195,3196],{"_3175":3189},{"_23":3197},"

The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.

To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.

The user's validation data isn't persisted.

","TemporaryPassword",{"_3172":3200},[3201,3203],{"_3175":3202},"#/definitions/365679",{"_23":3204},"

The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.

The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.

This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.

The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.

",{"_3172":3206},[3207,3209],{"_3175":3208},"#/definitions/365696",{"_23":3210},"

This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.

If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter 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. The previous user will no longer be able to log in using that alias.

If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.

","MessageAction",{"_3172":3213},[3214,3216],{"_3175":3215},"#/definitions/365684",{"_23":3217},"Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS to suppress sending the message. You can specify only one value.","DesiredDeliveryMediums",{"_3172":3220},[3221,3223],{"_3175":3222},"#/definitions/365682",{"_23":3224},"Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". You can specify more than one value.","ClientMetadata",{"_3172":3227},[3228,3230],{"_3175":3229},"#/definitions/365675",{"_23":3231},"

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 Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, 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 AdminCreateUser request. In your function code in 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.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

","Represents the request to create a user in the specified user pool.","x--orders",[3167,3168,3185,3192,3198,1992,3211,3218,3225],"definitions",{"_3237":3238,"_3239":3240,"_3248":3249,"_3254":3255,"_3260":3261,"_3264":3265,"_3270":3271,"_3274":3275,"_3280":3281,"_3282":3283,"_3285":3286,"_3288":3289,"_3291":3292,"_3311":3312},"365447",{"_5":3164,"_3165":3166,"_30":817,"_3169":3170,"_23":3232,"_3233":3234,"_22":817},"365672",{"_5":3241,"_3242":3243,"_3244":3245,"_3246":3247,"_30":1937,"_22":1937},"string","pattern","[\\w-]+_[0-9a-zA-Z]+","minLength",1,"maxLength",55,"365674",{"_5":3241,"_3242":3250,"_3244":3245,"_3246":3251,"_3252":3253,"_30":1947,"_22":1947},"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+",128,"format","password","365675",{"_5":3164,"_3256":3257,"_3233":3259,"_30":1957,"_22":1957},"additionalProperties",{"_3175":3258},"#/definitions/365685",[],"365679",{"_5":3241,"_3242":3262,"_3246":3263,"_3252":3253,"_30":1987,"_22":1987},"[\\S]+",256,"365680",{"_5":3266,"_3267":3268,"_30":1982,"_22":1982},"array","items",{"_3175":3269},"#/definitions/365738","365682",{"_5":3266,"_3267":3272,"_30":2002,"_22":2002},{"_3175":3273},"#/definitions/365752","365684",{"_5":3241,"_3276":3277,"_30":1997,"_22":1997},"enum",[3278,3279],"RESEND","SUPPRESS","365685",{"_5":3241,"_30":2017,"_22":2017},"365696",{"_5":3284,"_30":1992,"_22":1992},"boolean","365727",{"_5":3241,"_3242":3250,"_3244":3245,"_3246":3287,"_30":2222,"_22":2222},32,"365730",{"_5":3241,"_3246":3290,"_3252":3253,"_30":2227,"_22":2227},2048,"365738",{"_5":3164,"_3165":3293,"_3169":3295,"_23":3309,"_3233":3310,"_30":2207,"_22":2207},[3294],"Name",{"_3294":3296,"_3302":3303},{"_3172":3297},[3298,3300],{"_3175":3299},"#/definitions/365727",{"_23":3301},"The name of the attribute.","Value",{"_3172":3304},[3305,3307],{"_3175":3306},"#/definitions/365730",{"_23":3308},"The value of the attribute.","Specifies whether the attribute is standard or custom.",[3294,3302],"365752",{"_5":3241,"_3276":3313,"_30":2357,"_22":2357},[3314,3315],"SMS","EMAIL","extraData",{"_3318":3319,"_3320":3236,"_3321":3322,"_23":3232,"_3323":817},"apiFieldList",[],"dataSchemaDefinitions","example","{\n \"UserPoolId\": \"string\",\n \"Username\": \"string\",\n \"UserAttributes\": [],\n \"ValidationData\": [],\n \"TemporaryPassword\": \"string\",\n \"ForceAliasCreation\": true,\n \"MessageAction\": \"RESEND\",\n \"DesiredDeliveryMediums\": [],\n \"ClientMetadata\": {\n \"property1\": \"string\",\n \"property2\": \"string\"\n }\n}","displayName","docsIdTypeData",{"_3326":3327,"_3328":3329,"_3330":3329,"_3331":3332,"_3333":3334,"_3335":3336,"_3337":119,"_3338":-7},"onlineType","APIDOC","onlineId",345207,"projectId","teamId",83,"branchId",308344,"visitType","customDomain","subdirectory","specialFileType","notification",[],"footerBanner",[],"projectSetting",{"_3345":3346,"_3347":3348,"_3363":3364,"_3365":3366,"_3367":3368,"_3369":3370},"auth",{},"advancedSettings",{"_3349":53,"_3350":53,"_3351":51,"_3352":3353,"_3354":53,"_3355":53,"_3356":3357},"enableJsonc","enableBigint","responseValidate","isDefaultUrlEncoding",3,"enableTestScenarioSetting","enableYAPICompatScript","publishedDocUrlRules",{"_3358":3359,"_3360":3361,"_3362":51},"defaultRule","RESOURCE_KEY_ONLY","resourceKeyStandard","LEGACY","enableResourceKeyStandard","securityScheme",{},"mockSettings",{},"preProcessors",[],"postProcessors",[],"environments",{"_3373":-7,"_3374":3375,"_3376":3377},"selectedEnvironment","environmentList",[],"servers",[3378],{"_177":3138,"_22":3379},"Default Server","searchSettings",{},"versionSettings",[3384],{"_3333":3334,"_3385":51,"_22":3158,"_3386":3158,"_3371":3387},"isDefaultVersion","slug",{"_3388":3389,"_3390":176},"environmentIds",[],"defaultEnvironmentId","seoInfos",["M"],"itemPathPrefix",{"_3395":119,"_3396":119,"_3337":119,"_3397":53},"baseUrl","versionSlug","isSharedDocIndependentDomain","appEnvMap",{"_3400":131},"appBrowserExtensionAdapterKey","customCodes",{"_3403":119},"javascript","primaryColorVariable",{"_3066":3406,"_3070":3407},"--ui-primary-color-hover: var(--ui-primary-5);--ui-primary-color-active: var(--ui-primary-7);--ui-picker-basic-cell-hover-with-range-color: #36139c;--ui-picker-date-hover-range-border-color: #4e1be0;--ui-primary-base: #9373EE;--ui-primary-base-p: 147, 115, 238;--ui-primary-color-p: 147, 115, 238;--ui-primary-color: #9373EE;--ui-primary-10: #362b50;--ui-primary-9: #51407e;--ui-primary-8: #634e9b;--ui-primary-7: #7a60c4;--ui-primary-7-p: 122, 96, 196;--ui-primary-6: #9373EE;--ui-primary-6-p: 147, 115, 238;--ui-primary-5: #b499f4;--ui-primary-5-p: 180, 153, 244;--ui-primary-4: #cebaf8;--ui-primary-3: #dfd1fb;--ui-primary-2: #ebe2fc;--ui-primary-1: #f3eefe;--ui-primary-1-p: 243, 238, 254;--ui-primary-a: #f7f3fe;--ui-primary-b: #fbf9ff;--g-color-primary: #9373EE;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #ffffff;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","--ui-primary-color-hover: var(--ui-primary-7);--ui-primary-color-active: var(--ui-primary-5);--ui-picker-basic-cell-hover-with-range-color: #312865;--ui-picker-date-hover-range-border-color: #4b3d9c;--ui-primary-base: #8276C9;--ui-primary-base-p: 130, 118, 201;--ui-primary-color-p: 130, 118, 201;--ui-primary-color: #8276C9;--ui-primary-10: #dcd7f0;--ui-primary-9: #a69bd9;--ui-primary-8: #b0a5dd;--ui-primary-7: #9c90d4;--ui-primary-7-p: 156, 144, 212;--ui-primary-6: #8276C9;--ui-primary-6-p: 130, 118, 201;--ui-primary-5: #635a96;--ui-primary-5-p: 99, 90, 150;--ui-primary-4: #49436c;--ui-primary-3: #393452;--ui-primary-2: #312d46;--ui-primary-1: #252333;--ui-primary-1-p: 37, 35, 51;--ui-primary-a: #21202d;--ui-primary-b: #1e1c28;--g-color-primary: #8276C9;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #1a1922;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","routes/_index/route","actionData","errors"]

AdminCreateUserRequest(AdminCreateUserRequest)