An array of name-value pairs representing user attributes.

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

","ValidationData",{"_3171":3206},[3207,3208],{"_3174":3201},{"_23":3209},"The validation data in the request to register a user.","AnalyticsMetadata",{"_3171":3212},[3213,3215],{"_5":3162,"_3168":3214},{},{"_23":3216},"The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.","UserContextData",{"_3171":3219},[3220,3222],{"_3174":3221},"#/definitions/365762",{"_23":3223},"Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.","ClientMetadata",{"_3171":3226},[3227,3229],{"_3174":3228},"#/definitions/365675",{"_23":3230},"

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 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 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 register a user.","x--orders",[3165,3178,3166,3167,3197,3204,3210,3217,3224],"definitions",{"_3236":3237,"_3238":3239,"_3249":3250,"_3255":3256,"_3259":3260,"_3265":3266,"_3267":3268,"_3270":3271,"_3273":3274,"_3276":3277,"_3296":3297,"_3313":3314},"365630",{"_5":3162,"_3163":3164,"_30":1725,"_3168":3169,"_23":3231,"_3232":3233,"_22":1725},"365674",{"_5":3240,"_3241":3242,"_3243":3244,"_3245":3246,"_3247":3248,"_30":1945,"_22":1945},"string","pattern","[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+","minLength",1,"maxLength",128,"format","password","365675",{"_5":3162,"_3251":3252,"_3232":3254,"_30":1955,"_22":1955},"additionalProperties",{"_3174":3253},"#/definitions/365685",[],"365679",{"_5":3240,"_3241":3257,"_3245":3258,"_3247":3248,"_30":1985,"_22":1985},"[\\S]+",256,"365680",{"_5":3261,"_3262":3263,"_30":1980,"_22":1980},"array","items",{"_3174":3264},"#/definitions/365738","365685",{"_5":3240,"_30":2015,"_22":2015},"365694",{"_5":3240,"_3241":3269,"_3243":3244,"_3245":3246,"_3247":3248,"_30":2055,"_22":2055},"[\\w+]+","365727",{"_5":3240,"_3241":3242,"_3243":3244,"_3245":3272,"_30":2220,"_22":2220},32,"365730",{"_5":3240,"_3245":3275,"_3247":3248,"_30":2225,"_22":2225},2048,"365738",{"_5":3162,"_3163":3278,"_3168":3280,"_23":3294,"_3232":3295,"_30":2205,"_22":2205},[3279],"Name",{"_3279":3281,"_3287":3288},{"_3171":3282},[3283,3285],{"_3174":3284},"#/definitions/365727",{"_23":3286},"The name of the attribute.","Value",{"_3171":3289},[3290,3292],{"_3174":3291},"#/definitions/365730",{"_23":3293},"The value of the attribute.","Specifies whether the attribute is standard or custom.",[3279,3287],"365762",{"_5":3162,"_3168":3298,"_23":3311,"_3232":3312,"_30":2405,"_22":2405},{"_3299":3300,"_3305":3306},"IpAddress",{"_3171":3301},[3302,3303],{"_3174":3253},{"_23":3304},"The source IP address of your user's device.","EncodedData",{"_3171":3307},[3308,3309],{"_3174":3253},{"_23":3310},"Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.","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.",[3299,3305],"365776",{"_5":3240,"_3241":3315,"_3243":3244,"_3245":3246,"_3247":3248,"_30":2395,"_22":2395},"[\\w+=/]+","extraData",{"_3318":3319,"_3320":3235,"_3321":3322,"_23":3231,"_3323":1725},"apiFieldList",[],"dataSchemaDefinitions","example","{\n \"ClientId\": \"string\",\n \"SecretHash\": \"string\",\n \"Username\": \"string\",\n \"Password\": \"string\",\n \"UserAttributes\": [],\n \"ValidationData\": [],\n \"AnalyticsMetadata\": {},\n \"UserContextData\": {\n \"IpAddress\": \"string\",\n \"EncodedData\": \"string\"\n },\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":117,"_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":156,"_3350":156,"_3351":51,"_3352":3353,"_3354":156,"_3355":156,"_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],{"_176":3136,"_22":3379},"Default Server","searchSettings",{},"versionSettings",[3384],{"_3333":3334,"_3385":51,"_22":3156,"_3386":3156,"_3371":3387},"isDefaultVersion","slug",{"_3388":3389,"_3390":175},"environmentIds",[],"defaultEnvironmentId","seoInfos",["M"],"itemPathPrefix",{"_3395":117,"_3396":117,"_3337":117,"_3397":156},"baseUrl","versionSlug","isSharedDocIndependentDomain","appEnvMap",{"_3400":129},"appBrowserExtensionAdapterKey","customCodes",{"_3403":117},"javascript","primaryColorVariable",{"_3064":3406,"_3068":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"]

SignUpRequest(SignUpRequest)