logout_user ¶

logout_user(
    account_id: NonEmptyString,
    user_id: NonEmptyString,
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
) -> LogoutUserResponse

Logs out the specified user from all of the devices they are currently logged into.

Parameters:

account_id (NonEmptyString) –

The Amazon Chime account ID.
user_id (NonEmptyString) –

The user ID.

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/chime.py

def logout_user(
    self,
    account_id: "capo_chime.types.non_empty_string.NonEmptyString",
    user_id: "capo_chime.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
) -> "capo_chime.types.logout_user_response.LogoutUserResponse":
    """<p>Logs out the specified user from all of the devices they are currently logged into.</p>

    Args:
        account_id: <p>The Amazon Chime account ID.</p>
        user_id: <p>The user ID.</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.
    """

    def _handler(
        req: "OperationRequest[capo_chime.types.logout_user_request.LogoutUserRequest]",
    ) -> OperationResponse[
        "capo_chime.types.logout_user_response.LogoutUserResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.logout_user

        output, http_response = (
            capo_chime._operations.uc_buzz_console_service.logout_user.logout_user(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("LogoutUser")
    )
    input_: capo_chime.types.logout_user_request.LogoutUserRequest = {
        "account_id": account_id,
        "user_id": user_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output