create_user
async
¶
create_user(
*,
config_overrides: Optional[AsyncAppStreamClientConfig] = None,
user_name: Optional[Username] = None,
message_action: Optional[MessageAction] = None,
first_name: Optional[UserAttributeValue] = None,
last_name: Optional[UserAttributeValue] = None,
authentication_type: Optional[AuthenticationType] = None,
) -> CreateUserResult
Creates a new user in the user pool.
Parameters:
-
user_name(Optional[Username], default:None) –The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
-
message_action(Optional[MessageAction], default:None) –The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
-
first_name(Optional[UserAttributeValue], default:None) –The first name, or given name, of the user.
-
last_name(Optional[UserAttributeValue], default:None) –The last name, or surname, of the user.
-
authentication_type(Optional[AuthenticationType], default:None) –The authentication type for the user. You must specify USERPOOL.
Raises:
-
InvalidAccountStatusException–The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
-
InvalidParameterCombinationException–Indicates an incorrect combination of parameters, or a missing parameter.
-
LimitExceededException–The requested limit exceeds the permitted limit for an account.
-
OperationNotPermittedException–The attempted operation is not permitted.
-
ResourceAlreadyExistsException–The specified resource already exists.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_appstream/_services/async_app_stream.py
2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 | |