create_app_instance_user
async
¶
create_app_instance_user(
app_instance_arn: ChimeArn,
app_instance_user_id: UserId,
name: UserName,
client_request_token: ClientRequestToken,
*,
config_overrides: Optional[AsyncChimeSDKIdentityClientConfig] = None,
metadata: Optional[Metadata] = None,
tags: Optional[TagList] = None,
expiration_settings: Optional[ExpirationSettings] = None,
) -> CreateAppInstanceUserResponse
Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.
Parameters:
-
app_instance_arn(ChimeArn) –The ARN of the
AppInstancerequest. -
app_instance_user_id(UserId) –The user ID of the
AppInstance. -
name(UserName) –The user's name.
-
metadata(Optional[Metadata], default:None) –The request's metadata. Limited to a 1KB string in UTF-8.
-
client_request_token(ClientRequestToken) –The unique ID of the request. Use different tokens to request additional
AppInstances. -
tags(Optional[TagList], default:None) –Tags assigned to the
AppInstanceUser. -
expiration_settings(Optional[ExpirationSettings], default:None) –Settings that control the interval after which the
AppInstanceUseris automatically deleted.
Raises:
-
BadRequestException–The input parameters don't match the service's restrictions.
-
ConflictException–The request could not be processed because of conflict in the current state of the resource.
-
ForbiddenException–The client is permanently forbidden from making the request.
-
ResourceLimitExceededException–The request exceeds the resource limit.
-
ServiceFailureException–The service encountered an unexpected error.
-
ServiceUnavailableException–The service is currently unavailable.
-
ThrottledClientException–The client exceeded its request rate limit.
-
UnauthorizedClientException–The client is not currently authorized to make the request.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_chime_sdk_identity/_services/async_chime_sdk_identity.py
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 | |