Skip to content

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 AppInstance request.

  • 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 AppInstanceUser is automatically deleted.

Raises:

Source code in docs_src/capo_chime_sdk_identity/_services/async_chime_sdk_identity.py
async def create_app_instance_user(
    self,
    app_instance_arn: "capo_chime_sdk_identity.types.chime_arn.ChimeArn",
    app_instance_user_id: "capo_chime_sdk_identity.types.user_id.UserId",
    name: "capo_chime_sdk_identity.types.user_name.UserName",
    client_request_token: "capo_chime_sdk_identity.types.client_request_token.ClientRequestToken",
    *,
    config_overrides: Optional[AsyncChimeSDKIdentityClientConfig] = None,
    metadata: Optional["capo_chime_sdk_identity.types.metadata.Metadata"] = None,
    tags: Optional["capo_chime_sdk_identity.types.tag_list.TagList"] = None,
    expiration_settings: Optional[
        "capo_chime_sdk_identity.types.expiration_settings.ExpirationSettings"
    ] = None,
) -> "capo_chime_sdk_identity.types.create_app_instance_user_response.CreateAppInstanceUserResponse":
    """<p>Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a unique <code>appInstanceUserId</code> and <code>Name</code> for that user.</p>

    Args:
        app_instance_arn: <p>The ARN of the <code>AppInstance</code> request.</p>
        app_instance_user_id: <p>The user ID of the <code>AppInstance</code>.</p>
        name: <p>The user's name.</p>
        metadata: <p>The request's metadata. Limited to a 1KB string in UTF-8.</p>
        client_request_token: <p>The unique ID of the request. Use different tokens to request additional <code>AppInstances</code>.</p>
        tags: <p>Tags assigned to the <code>AppInstanceUser</code>.</p>
        expiration_settings: <p>Settings that control the interval after which the <code>AppInstanceUser</code> is automatically deleted.</p>

    Raises:
        capo_chime_sdk_identity.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_identity.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</p>
        capo_chime_sdk_identity.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_identity.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>The request exceeds the resource limit.</p>
        capo_chime_sdk_identity.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_identity.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_identity.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_identity.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_identity.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_identity.types.create_app_instance_user_request.CreateAppInstanceUserRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_identity.types.create_app_instance_user_response.CreateAppInstanceUserResponse"
    ]:
        import capo_chime_sdk_identity._operations.chime_identity_service.create_app_instance_user

        (
            output,
            http_response,
        ) = await capo_chime_sdk_identity._operations.chime_identity_service.create_app_instance_user.async_create_app_instance_user(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_identity.types.create_app_instance_user_request.CreateAppInstanceUserRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_identity.types.create_app_instance_user_request

        return capo_chime_sdk_identity.types.create_app_instance_user_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateAppInstanceUser", redact_input=_redact_input),
    )
    input_: capo_chime_sdk_identity.types.create_app_instance_user_request.CreateAppInstanceUserRequest = {
        "app_instance_arn": app_instance_arn,
        "app_instance_user_id": app_instance_user_id,
        "name": name,
        "client_request_token": client_request_token,
    }
    if metadata is not None:
        input_["metadata"] = metadata
    if tags is not None:
        input_["tags"] = tags
    if expiration_settings is not None:
        input_["expiration_settings"] = expiration_settings

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output