invite_users async ¶

async def invite_users(
    self,
    account_id: "capo_chime.types.non_empty_string.NonEmptyString",
    user_email_list: "capo_chime.types.user_email_list.UserEmailList",
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
    user_type: Optional["capo_chime.types.user_type.UserType"] = None,
) -> "capo_chime.types.invite_users_response.InviteUsersResponse":
    """<p>Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime <code>Team</code> account. Only <code>Team</code> account types are currently supported for this action.</p>

    Args:
        account_id: <p>The Amazon Chime account ID.</p>
        user_email_list: <p>The user email addresses to which to send the email invitation.</p>
        user_type: <p>The user type.</p>

    Raises:
        capo_chime.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime.types.invite_users_request.InviteUsersRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime.types.invite_users_response.InviteUsersResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.invite_users

        (
            output,
            http_response,
        ) = await capo_chime._operations.uc_buzz_console_service.invite_users.async_invite_users(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime.types.invite_users_request.InviteUsersRequest",
    ) -> dict[str, Any]:
        import capo_chime.types.invite_users_request

        return capo_chime.types.invite_users_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_chime.types.invite_users_response.InviteUsersResponse",
    ) -> dict[str, Any]:
        import capo_chime.types.invite_users_response

        return capo_chime.types.invite_users_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "InviteUsers", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_chime.types.invite_users_request.InviteUsersRequest = {
        "account_id": account_id,
        "user_email_list": user_email_list,
    }
    if user_type is not None:
        input_["user_type"] = user_type

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