batch_suspend_user `async` ¶

batch_suspend_user(
    account_id: NonEmptyString,
    user_id_list: UserIdList,
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
) -> BatchSuspendUserResponse

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

Parameters:

account_id (NonEmptyString) –

The Amazon Chime account ID.
user_id_list (UserIdList) –

The request containing the user IDs to suspend.

Raises:

BadRequestException –

The input parameters don't match the service's restrictions.
ForbiddenException –

The client is permanently forbidden from making the request.
NotFoundException –

One or more of the resources in the request does not exist in the system.
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/_services/async_chime.py

async def batch_suspend_user(
    self,
    account_id: "capo_chime.types.non_empty_string.NonEmptyString",
    user_id_list: "capo_chime.types.user_id_list.UserIdList",
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
) -> "capo_chime.types.batch_suspend_user_response.BatchSuspendUserResponse":
    """<p>Suspends up to 50 users from a <code>Team</code> or <code>EnterpriseLWA</code> Amazon Chime account. For more information about different account types, see <a href="https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p>Users suspended from a <code>Team</code> account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended <code>Team</code> account users, invite them to the <code>Team</code> account again. You can use the <a>InviteUsers</a> action to do so.</p> <p>Users suspended from an <code>EnterpriseLWA</code> account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the <a>BatchUnsuspendUser</a> action.</p> <p> To sign out users without suspending them, use the <a>LogoutUser</a> action.</p>

    Args:
        account_id: <p>The Amazon Chime account ID.</p>
        user_id_list: <p>The request containing the user IDs to suspend.</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.batch_suspend_user_request.BatchSuspendUserRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime.types.batch_suspend_user_response.BatchSuspendUserResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.batch_suspend_user

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchSuspendUser")
    )
    input_: capo_chime.types.batch_suspend_user_request.BatchSuspendUserRequest = {
        "account_id": account_id,
        "user_id_list": user_id_list,
    }

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

batch_suspend_user async ¶

batch_suspend_user `async` ¶