batch_toggle_user_suspend_status ¶

def batch_toggle_user_suspend_status(
    self,
    network_id: "capo_wickr.types.network_id.NetworkId",
    suspend: bool,
    user_ids: "capo_wickr.types.user_ids.UserIds",
    *,
    config_overrides: Optional[WickrClientConfig] = None,
    client_token: Optional["capo_wickr.types.client_token.ClientToken"] = None,
) -> "capo_wickr.types.batch_toggle_user_suspend_status_response.BatchToggleUserSuspendStatusResponse":
    """<p>Suspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.</p>

    Args:
        network_id: <p>The ID of the Wickr network where users will be suspended or unsuspended.</p>
        suspend: <p>A boolean value indicating whether to suspend (true) or unsuspend (false) the specified users.</p>
        user_ids: <p>A list of user IDs identifying the users whose suspend status will be toggled. Maximum 50 users per batch request.</p>
        client_token: <p>A unique identifier for this request to ensure idempotency.</p>

    Raises:
        capo_wickr.errors.bad_request_error.BadRequestError: <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
        capo_wickr.errors.forbidden_error.ForbiddenError: <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
        capo_wickr.errors.internal_server_error.InternalServerError: <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
        capo_wickr.errors.rate_limit_error.RateLimitError: <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
        capo_wickr.errors.resource_not_found_error.ResourceNotFoundError: <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
        capo_wickr.errors.unauthorized_error.UnauthorizedError: <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
        capo_wickr.errors.validation_error.ValidationError: <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
        capo_wickr.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Suspend multiple users

        >>> client.batch_toggle_user_suspend_status(network_id='12345678', user_ids=['123', '456'], suspend=True, client_token='6ba7b815-9dad-11d1-80b4-00c04fd430c8')
        Unsuspend users with partial failure

        >>> client.batch_toggle_user_suspend_status(network_id='12345678', user_ids=['123', '456'], suspend=False)
    """

    def _handler(
        req: "OperationRequest[capo_wickr.types.batch_toggle_user_suspend_status_request.BatchToggleUserSuspendStatusRequest]",
    ) -> OperationResponse[
        "capo_wickr.types.batch_toggle_user_suspend_status_response.BatchToggleUserSuspendStatusResponse"
    ]:
        import capo_wickr._operations.wickr_admin_api.batch_toggle_user_suspend_status

        output, http_response = (
            capo_wickr._operations.wickr_admin_api.batch_toggle_user_suspend_status.batch_toggle_user_suspend_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchToggleUserSuspendStatus")
    )
    input_: capo_wickr.types.batch_toggle_user_suspend_status_request.BatchToggleUserSuspendStatusRequest = {
        "network_id": network_id,
        "suspend": suspend,
        "user_ids": user_ids,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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