update_guest_user ¶

def update_guest_user(
    self,
    network_id: "capo_wickr.types.network_id.NetworkId",
    username_hash: "capo_wickr.types.generic_string.GenericString",
    block: bool,
    *,
    config_overrides: Optional[WickrClientConfig] = None,
) -> "capo_wickr.types.update_guest_user_response.UpdateGuestUserResponse":
    """<p>Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing the network.</p>

    Args:
        network_id: <p>The ID of the Wickr network where the guest user's status will be updated.</p>
        username_hash: <p>The username hash (unique identifier) of the guest user to update.</p>
        block: <p>Set to true to block the guest user or false to unblock them.</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:
        Block a guest user

        >>> client.update_guest_user(network_id='12345678', username_hash='032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d', block=True)
        Unblock a guest user

        >>> client.update_guest_user(network_id='12345678', username_hash='032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d', block=False)
        User already blocked error

        >>> client.update_guest_user(network_id='12345678', username_hash='032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d', block=True)
    """

    def _handler(
        req: "OperationRequest[capo_wickr.types.update_guest_user_request.UpdateGuestUserRequest]",
    ) -> OperationResponse[
        "capo_wickr.types.update_guest_user_response.UpdateGuestUserResponse"
    ]:
        import capo_wickr._operations.wickr_admin_api.update_guest_user

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateGuestUser")
    )
    input_: capo_wickr.types.update_guest_user_request.UpdateGuestUserRequest = {
        "network_id": network_id,
        "username_hash": username_hash,
        "block": block,
    }

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